StatusSupportGet API keys
Funding

Cancel an order

POST/v1/teller/order/cancel

Changes an order status from waiting-user to cancelled. Use this when the user decides not to proceed with a card payment that is awaiting confirmation.

Authorization

ApiKeyAuth
X-Api-Key<token>

For accessing these endpoints a valid API key must be sent in the X-Api-Key header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

Cancel an order
curl --request POST \  --url 'https://gateway.bit2me.com/v1/teller/order/cancel' \  --header 'Content-Type: application/json' \  --data '{  "description": "User requested cancellation",  "orderId": "dfcf2797-05f2-4cbb-ae5b-f5608dbbf6a9"}'
{  "orderId": "dfcf2797-05f2-4cbb-ae5b-f5608dbbf6a9",  "status": "cancelled"}

Execute an order POST

Executes an order previously created with `POST /v1/teller/order/proforma`, charging it with the payment method chosen there. A proforma can be executed only once and only while it is valid, so an expired one has to be created again. When the user has to complete the payment, for example to pass 3-D Secure on a card or to approve a Bizum payment, the response comes with `status: waiting-user` and `provider.requestConfiguration` says how: open its `uri` when `type` is `iframe`, or wait for the user to approve it outside the app when `type` is `external`.

Create an order proforma POST

Creates an order proforma: it prices the order, with its fees and any discount, without charging anything. Show the breakdown to the user and, if they accept, execute it with `POST /v1/teller/order` and the returned `orderId`. A proforma is valid for a limited time and can be executed only once. To refresh the price, create a new one.