Payment links

List payment links

GET/links

Authorization

oauth2 links:read

AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: links:read

Query Parameters

page?integer

per_page?integer

At most 100.

search?string

Text to look for.

status?string

Filter by status.

usage_mode?string

Filter by usage mode.

payment_instance_id?string

Filter by payment instance.

sort_by?string

Field to sort by.

sort_dir?string

Sort direction.

Response Body

`application/json`

curl -X GET "https://api.mytpe.app/api/ext/links" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "payment_instance_id": "63c9f7be-d877-42d2-bb44-1f2937d118ab",
      "owner": {},
      "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
      "slug": "string",
      "title": "string",
      "description": "string",
      "logo": "string",
      "own_logo": "string",
      "amount_mode": "fixed",
      "amount": 0,
      "min_amount": 0,
      "max_amount": 0,
      "amount_options": [
        {
          "label": "string",
          "amount": 0
        }
      ],
      "allow_custom_amount": true,
      "currency": "string",
      "usage_mode": "one_shot",
      "max_uses": 0,
      "target_amount": 0,
      "starts_at": "2019-08-24T14:15:22Z",
      "ends_at": "2019-08-24T14:15:22Z",
      "expires_at": "2019-08-24T14:15:22Z",
      "paid_count": 0,
      "total_collected": 0,
      "status": "draft",
      "allowed_payers": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "email": "string",
          "phone": "string",
          "used_at": "2019-08-24T14:15:22Z"
        }
      ],
      "metadata": {},
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "abilities": [
        "string"
      ]
    }
  ],
  "meta": {
    "current_page": 0,
    "last_page": 0,
    "per_page": 100,
    "total": 0,
    "from": 0,
    "to": 0,
    "path": "string",
    "links": []
  },
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Create a payment link

POST/links

Authorization

oauth2 links:write

AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: links:write

Header Parameters

Idempotency-Key?string

8 to 128 characters, unique per operation within the account. Repeating it returns the first response with Idempotent-Replayed: true.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

payment_instance_id*string

currency?|

DZD when absent.

sector_type?|

For amount_mode: sector.

sector_config?|

For amount_mode: sector.

form_id?|

A form of the same account.

title*string

description?|

slug?|

Generated when absent. Fixed once the link is published.

amount_mode*CreatableAmountMode

The modes you can set on a link. For instalments, create a plan with POST /plans.

amount?|

In dinars.

min_amount?|

In dinars.

max_amount?|

In dinars.

amount_options?array<>|

allow_custom_amount?boolean|null

usage_mode*UsageMode

max_uses?|

target_amount?|

In dinars.

starts_at?|

ends_at?|

expires_at?|

allowed_payers?array<>|null

metadata?|null

Response Body

`application/json`

curl -X POST "https://api.mytpe.app/api/ext/links" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \  -H "Idempotency-Key: your-unique-key" \  -H "Content-Type: application/json" \  -d '{"payment_instance_id": "your-payment-instance-id", "title": "Your title", "amount_mode": "fixed", "usage_mode": "one_shot", "amount": 1000}'

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "payment_instance_id": "63c9f7be-d877-42d2-bb44-1f2937d118ab",
    "owner": {},
    "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
    "slug": "string",
    "title": "string",
    "description": "string",
    "logo": "string",
    "own_logo": "string",
    "amount_mode": "fixed",
    "amount": 0,
    "min_amount": 0,
    "max_amount": 0,
    "amount_options": [
      {
        "label": "string",
        "amount": 0
      }
    ],
    "allow_custom_amount": true,
    "currency": "string",
    "usage_mode": "one_shot",
    "max_uses": 0,
    "target_amount": 0,
    "starts_at": "2019-08-24T14:15:22Z",
    "ends_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "paid_count": 0,
    "total_collected": 0,
    "status": "draft",
    "allowed_payers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "string",
        "phone": "string",
        "used_at": "2019-08-24T14:15:22Z"
      }
    ],
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "abilities": [
      "string"
    ]
  },
  "meta": {},
  "error": null
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Get a payment link

GET/links/{id}

Authorization

oauth2 links:read

AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: links:read

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "https://api.mytpe.app/api/ext/links/your-id" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "payment_instance_id": "63c9f7be-d877-42d2-bb44-1f2937d118ab",
    "owner": {},
    "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
    "slug": "string",
    "title": "string",
    "description": "string",
    "logo": "string",
    "own_logo": "string",
    "amount_mode": "fixed",
    "amount": 0,
    "min_amount": 0,
    "max_amount": 0,
    "amount_options": [
      {
        "label": "string",
        "amount": 0
      }
    ],
    "allow_custom_amount": true,
    "currency": "string",
    "usage_mode": "one_shot",
    "max_uses": 0,
    "target_amount": 0,
    "starts_at": "2019-08-24T14:15:22Z",
    "ends_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "paid_count": 0,
    "total_collected": 0,
    "status": "draft",
    "allowed_payers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "string",
        "phone": "string",
        "used_at": "2019-08-24T14:15:22Z"
      }
    ],
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "abilities": [
      "string"
    ]
  },
  "meta": {},
  "error": null
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Update a payment link

PUT/links/{id}

Authorization

oauth2 links:write

AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: links:write

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sector_type?|

For amount_mode: sector.

sector_config?|

For amount_mode: sector.

form_id?|

A form of the same account.

title?string

description?|

slug?|

Generated when absent. Fixed once the link is published.

amount_mode?CreatableAmountMode

The modes you can set on a link. For instalments, create a plan with POST /plans.

amount?|

In dinars.

min_amount?|

In dinars.

max_amount?|

In dinars.

amount_options?array<>|

allow_custom_amount?boolean|null

usage_mode?UsageMode

max_uses?|

target_amount?|

In dinars.

starts_at?|

ends_at?|

expires_at?|

allowed_payers?array<>|null

metadata?|null

Response Body

`application/json`

curl -X PUT "https://api.mytpe.app/api/ext/links/your-id" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{"sector_type": "Your sector type"}'

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "payment_instance_id": "63c9f7be-d877-42d2-bb44-1f2937d118ab",
    "owner": {},
    "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
    "slug": "string",
    "title": "string",
    "description": "string",
    "logo": "string",
    "own_logo": "string",
    "amount_mode": "fixed",
    "amount": 0,
    "min_amount": 0,
    "max_amount": 0,
    "amount_options": [
      {
        "label": "string",
        "amount": 0
      }
    ],
    "allow_custom_amount": true,
    "currency": "string",
    "usage_mode": "one_shot",
    "max_uses": 0,
    "target_amount": 0,
    "starts_at": "2019-08-24T14:15:22Z",
    "ends_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "paid_count": 0,
    "total_collected": 0,
    "status": "draft",
    "allowed_payers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "string",
        "phone": "string",
        "used_at": "2019-08-24T14:15:22Z"
      }
    ],
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "abilities": [
      "string"
    ]
  },
  "meta": {},
  "error": null
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Archive a payment link

POST/links/{id}/archive

Authorization

oauth2 links:write

AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: links:write

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://api.mytpe.app/api/ext/links/your-id/archive" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"

{
  "message": "string"
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Pause a payment link

POST/links/{id}/pause

Authorization

oauth2 links:write

AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: links:write

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://api.mytpe.app/api/ext/links/your-id/pause" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "payment_instance_id": "63c9f7be-d877-42d2-bb44-1f2937d118ab",
    "owner": {},
    "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
    "slug": "string",
    "title": "string",
    "description": "string",
    "logo": "string",
    "own_logo": "string",
    "amount_mode": "fixed",
    "amount": 0,
    "min_amount": 0,
    "max_amount": 0,
    "amount_options": [
      {
        "label": "string",
        "amount": 0
      }
    ],
    "allow_custom_amount": true,
    "currency": "string",
    "usage_mode": "one_shot",
    "max_uses": 0,
    "target_amount": 0,
    "starts_at": "2019-08-24T14:15:22Z",
    "ends_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "paid_count": 0,
    "total_collected": 0,
    "status": "draft",
    "allowed_payers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "string",
        "phone": "string",
        "used_at": "2019-08-24T14:15:22Z"
      }
    ],
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "abilities": [
      "string"
    ]
  },
  "meta": {},
  "error": null
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Publish a payment link

POST/links/{id}/publish

Authorization

oauth2 links:write

AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: links:write

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://api.mytpe.app/api/ext/links/your-id/publish" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "payment_instance_id": "63c9f7be-d877-42d2-bb44-1f2937d118ab",
    "owner": {},
    "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
    "slug": "string",
    "title": "string",
    "description": "string",
    "logo": "string",
    "own_logo": "string",
    "amount_mode": "fixed",
    "amount": 0,
    "min_amount": 0,
    "max_amount": 0,
    "amount_options": [
      {
        "label": "string",
        "amount": 0
      }
    ],
    "allow_custom_amount": true,
    "currency": "string",
    "usage_mode": "one_shot",
    "max_uses": 0,
    "target_amount": 0,
    "starts_at": "2019-08-24T14:15:22Z",
    "ends_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "paid_count": 0,
    "total_collected": 0,
    "status": "draft",
    "allowed_payers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "string",
        "phone": "string",
        "used_at": "2019-08-24T14:15:22Z"
      }
    ],
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "abilities": [
      "string"
    ]
  },
  "meta": {},
  "error": null
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Resume a payment link

POST/links/{id}/resume

Authorization

oauth2 links:write

AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: links:write

Path Parameters

id*string

Response Body

`application/json`

curl -X POST "https://api.mytpe.app/api/ext/links/your-id/resume" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "payment_instance_id": "63c9f7be-d877-42d2-bb44-1f2937d118ab",
    "owner": {},
    "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
    "slug": "string",
    "title": "string",
    "description": "string",
    "logo": "string",
    "own_logo": "string",
    "amount_mode": "fixed",
    "amount": 0,
    "min_amount": 0,
    "max_amount": 0,
    "amount_options": [
      {
        "label": "string",
        "amount": 0
      }
    ],
    "allow_custom_amount": true,
    "currency": "string",
    "usage_mode": "one_shot",
    "max_uses": 0,
    "target_amount": 0,
    "starts_at": "2019-08-24T14:15:22Z",
    "ends_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "paid_count": 0,
    "total_collected": 0,
    "status": "draft",
    "allowed_payers": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "email": "string",
        "phone": "string",
        "used_at": "2019-08-24T14:15:22Z"
      }
    ],
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "abilities": [
      "string"
    ]
  },
  "meta": {},
  "error": null
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

{
  "errors": [
    {
      "status": "string",
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": []
    }
  ]
}

Payment links

200application/json

401application/json

403application/json

429application/json

200application/json

401application/json

403application/json

409application/json

413application/json

422application/json

429application/json

200application/json

401application/json

403application/json

404application/json

429application/json

200application/json

401application/json

403application/json

404application/json

413application/json

422application/json

429application/json

200application/json

401application/json

403application/json

404application/json

413application/json

422application/json

429application/json

200application/json

401application/json

403application/json

404application/json

413application/json

422application/json

429application/json

200application/json

401application/json

403application/json

404application/json

413application/json

422application/json

429application/json

200application/json

401application/json

403application/json

404application/json

413application/json

422application/json

429application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`