Build payments into your product with TPE virtual. Start integrating →
Logo

Payment instances

Request and manage virtual TPEs.

List payment instances

GET/instances

Authorization

oauth2 instances:read
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: instances:read

Query Parameters

page?integer
per_page?integer

At most 100.

search?string

Text to look for.

status?string

Filter by operational status.

acceptance_status?string

Filter by acceptance status.

identification_id?string

Filter by identification.

brand_id?string

Filter by brand.

bank_account_id?string

Filter by bank account.

sort_by?string

Field to sort by.

sort_dir?string

Sort direction.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.mytpe.app/api/ext/instances" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
      "owner": {},
      "title": "string",
      "logo": "string",
      "status": "string",
      "acceptance_status": "string",
      "acceptance_reason": "string",
      "acquiring_mode": "string",
      "delegated_available": true,
      "direct_available": true,
      "identification_id": "a56e8e84-dbe6-4202-a30e-1c3cb0ec2163",
      "identification": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "brand_id": "1bb61461-e5e3-4ebb-8cc6-5b0c37f1b7da",
      "brand": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string"
      },
      "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
      "bank_account": {},
      "total_collected": 0,
      "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": []
    }
  ]
}

Request a payment instance

POST/instances

Authorization

oauth2 instances:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: instances: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

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.mytpe.app/api/ext/instances" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \  -H "Idempotency-Key: your-unique-key" \  -F "title=Your title" \  -F "identification_id=your-identification-id" \  -F "brand_id=your-brand-id" \  -F "bank_account_id=your-bank-account-id" \  -F "payment_method=online"
{
  "data": {
    "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
    "status": "string",
    "payment_method": "online",
    "amount": 0,
    "currency": "string",
    "form_url": "http://example.com"
  },
  "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 instance

GET/instances/{id}

Authorization

oauth2 instances:read
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: instances:read

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.mytpe.app/api/ext/instances/your-id" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "owner": {},
    "title": "string",
    "logo": "string",
    "status": "string",
    "acceptance_status": "string",
    "acceptance_reason": "string",
    "acquiring_mode": "string",
    "delegated_available": true,
    "direct_available": true,
    "identification_id": "a56e8e84-dbe6-4202-a30e-1c3cb0ec2163",
    "identification": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "brand_id": "1bb61461-e5e3-4ebb-8cc6-5b0c37f1b7da",
    "brand": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
    "bank_account": {},
    "total_collected": 0,
    "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": []
    }
  ]
}

Delete a payment instance

DELETE/instances/{id}

Authorization

oauth2 instances:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: instances:write

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://api.mytpe.app/api/ext/instances/your-id" \  -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": []
    }
  ]
}

Update a payment instance

PUT/instances/{id}

Authorization

oauth2 instances:write
AuthorizationBearer <token>

A short-lived token for one installation.

In: header

Scope: instances:write

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://api.mytpe.app/api/ext/instances/your-id" \  -H "Authorization: Bearer $MYTPE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{"title": "Your title"}'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "owner": {},
    "title": "string",
    "logo": "string",
    "status": "string",
    "acceptance_status": "string",
    "acceptance_reason": "string",
    "acquiring_mode": "string",
    "delegated_available": true,
    "direct_available": true,
    "identification_id": "a56e8e84-dbe6-4202-a30e-1c3cb0ec2163",
    "identification": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "brand_id": "1bb61461-e5e3-4ebb-8cc6-5b0c37f1b7da",
    "brand": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "bank_account_id": "9335a679-63ab-44d5-9de9-e01e0c5a1fff",
    "bank_account": {},
    "total_collected": 0,
    "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": []
    }
  ]
}
PostmanPostman collection

On this page

List payment instancesRequest a payment instanceGet a payment instanceDelete a payment instanceUpdate a payment instance