Create checkout

Initiate a checkout that deposits funds to a specific funding source (wallet).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

The amount. Represented as a string for precision.

currency*string

Value in"CAD"

expiresIn*integer

Expiry in seconds. Default is 3600 (1 hour). Minimum = 300 (5 minutes), maximum 2592000 (30 days)

Formatint32

Range300 <= value <= 2592000

externalId?|

A freeform field we will store your behalf. Once you receive webhooks for status updates of this checkout, you can use this ID to identify the checkout on your side. For example, you can pass your order ID.

fundingSourceId*string

The ID of your wallet (funding source) that the checkout will be deposited into, automatically.

redirectUrlFailure?|

The URL to redirect the customer after the checkout expires. Only used for the checkout gateway. You can ignore this if you're building the frontend for checkouts yourself.

redirectUrlSuccess?|

The URL to redirect the customer after a successful checkout. Only used for the checkout gateway. You can ignore this if you're building the frontend for checkouts yourself.

Response Body

`application/json`

curl -X POST "https://api.invinciblepay.com/v1/checkout" \  -H "Content-Type: application/json" \  -d '{    "amount": "string",    "currency": "CAD",    "expiresIn": 300,    "fundingSourceId": "string"  }'

{
  "accountId": "string",
  "amount": "string",
  "createdAt": 0,
  "currency": "CAD",
  "expiresAt": 0,
  "externalId": "string",
  "fundingSourceId": "string",
  "id": "string",
  "paymentUrl": "string",
  "redirectUrlFailure": "string",
  "redirectUrlSuccess": "string",
  "reference": "string",
  "status": "pending",
  "transactionId": "string"
}

{
  "error": "string",
  "error_code": {}
}

Create checkout

Request Body

Response Body

200application/json

500application/json

`application/json`

`application/json`