Create checkout

Create payment forms to accept payments in your online business easily and simply. To create a form, you will need to submit the following required information.

You must submit your api key, your business name, and the total transaction amount in the body of the request.

Example of creating a Checkout

{
  "apiKey": "123ABC0-123ABC0-123ABC0-123ABC0",
  "externalId": "Kushki",
  "items": [
    "Product 1",
    "Product 2",
    "Product 3"
  ],
  "total": 1000,
  "rates": []
}

Response example of a successfully created Checkout

If the request has been successful, you will get a response like the following:

{
  "checkoutId": "e8bfb912-c51a-4c62-bb22-876f1f9cc6d1",
  "externalId": "Kushki",
  "total": "5000.00",
  "items": [
    "Product 1",
    "Product 2"
  ],
  "rates": [
    3,
    6
  ],
  "description": "Example",
  "createdAt": "2024-06-12T03:07:25.049Z",
  "updatedAt": "2024-06-12T03:07:25.049Z"
}

Create payment form

To create a payment form, you must concatenate the checkoutId obtained in the response to the following url depending on the environment.

Environment	Url
Dev	https://test.paywith.billpocket.com/checkout/{checkoutId}
Live	https://paywith.billpocket.com/checkout/{checkoutId}

Checkout example: https://test.paywith.billpocket.com/checkout/df60ccad-2d72-42fb-a813-5c745f3cd8db

Check testcards to do test transactions in the Dev environment.

curl --location --request POST '/api/v1/checkout' \ --header 'Content-Type: application/json' \ --data-raw '{ "apiKey": "123ABC0-123ABC0-123ABC0-123ABC0", "externalId": "Kushki", "items": [ "Product 1", "Product 2", "Product 3" ], "total": 1000, "rates": [] }'

{ "checkoutId": "e8bfb912-c51a-4c62-bb22-876f1f9cc6d1", "externalId": "Kushki", "total": "5000.00", "items": [ "Product 1", "Product 2" ], "rates": [ 3, 6 ], "description": "Example", "createdAt": "2024-06-12T03:07:25.049Z", "updatedAt": "2024-06-12T03:07:25.049Z" }

Example of creating a Checkout

Response example of a successfully created Checkout

Create payment form

Request

Responses

Create checkout

Example of creating a Checkout#

Response example of a successfully created Checkout#

Create payment form#

Request

Responses

Example of creating a Checkout

Response example of a successfully created Checkout

Create payment form