Skip to main content

Info

Retrieving payment info​

In order to get detailed information about a particular payment you need to send a GET request with the slug of the payment on it:

URL

https://api.bembit.com/api/v1/checkouts/{slug}

Method

GET

Params

Important

Params for this request must be included on the URL.

ParamsTypeDefault valuesDescription
slugstringundefinedCheckout link alias (Defined when the link is created).

cURL

curl -X 'GET' \
  'https://api.bembit.com/api/v1/checkouts/{slug}' \
  -H 'accept: application/json'

Server Responses:​

Status 200:​

Response Body:

{
  "title": "string",
  "description": "string",
  "slug": "string",
  "active": true,
  "paymentMethodPix": {
    "expiryTimeInMinutes": 0,
    "enabled": true
  },
  "paymentMethodCrypto": {
    "highlightTokens": ["string"],
    "enabled": true,
    "allTokens": true,
    "expiryTimeInMinutes": 0
  },
  "logo": "string",
  "createdAt": "2023-06-07T12:55:04.759Z",
  "updatedAt": "2023-06-07T12:55:04.759Z",
  "id": "string"
}
  • Title: It's Checkout's title, defined when the link is first created.
  • Description: Payment description.
  • Slug: Payment's alias (defined when the link is first created).
  • Active: Checkout's link status.
  • paymentMethodPix / expiryTimeInMinutes: Time in minutes for the QR Code's lifetime.
  • paymentMethodPix / enabled: Indicate the instances in which the PIX payment method is accessible for the ongoing payment process.
  • paymentMethodCrypto / highlightTokens: It's an Array of strings that contains all the symbols from the accepted cryptocurrencies for the ongoing payment.
  • paymentMethodCrypto / enabled: Indicate the instances in which the Crypto payment method is accessible for the ongoing payment process.
  • paymentMethodCrypto / allTokens: It will appear as true when all cryptocurrencies are accepted on the current payment.
  • paymentMethodCrypto / expiryTimeInMinutes: Time in minutes for the current's payment lifetime.
  • Logo: The URL of the payment's logo image.
  • CreatedAt: Payment creation date.
  • UpdatedAt: Payment update date.
  • Id: The ongoing payment ID.

Status 404:​

Response Body:

{
  "httpCode": 404,
  "description": "Checkout not found."
}

See and test our API on Swagger.