Checkout

Checkout process endpoints

List all checkout sessions

get

https://stage-capi.wewireafrica.comhttps://capi.wewireafrica.com

/api/v1/checkout

Authorizations

bearerww-api-key

Responses

200

The checkout sessions

application/json

get

/api/v1/checkout

HTTPcURLJavaScriptPython

GET /api/v1/checkout HTTP/1.1
Host: stage-capi.wewireafrica.com
Accept: */*

200

The checkout sessions

[
  {
    "id": "text",
    "currency": "text",
    "amount": 1,
    "email": "text",
    "name": "text",
    "productId": "text",
    "productName": "text",
    "productDescription": "text",
    "allowedAssets": [
      "text"
    ],
    "expiresAt": "text",
    "metadata": {},
    "customerId": "text",
    "redirectUrl": "text",
    "cancelUrl": "text",
    "createdAt": "text",
    "updatedAt": "text",
    "customer": {}
  }
]

Create a new checkout session

post

https://stage-capi.wewireafrica.comhttps://capi.wewireafrica.com

/api/v1/checkout

Authorizations

bearerww-api-key

Body

application/json

amountnumberRequired

The amount to charge the customer

Example: 100

currencystring · enumRequired

The currency to charge the customer

Example: USDPossible values:

successUrlstringRequired

The URL to redirect the customer to after the payment is successful

Example: https://example.com/success

cancelUrlstringRequired

The URL to redirect the customer to after the payment is cancelled

Example: https://example.com/cancel

emailstringRequired

The email of the customer

Example: [email protected]

namestringRequired

The name of the customer

Example: John Doe

metadataobjectRequired

Additional metadata about the checkout session. This will be returned in the webhooks for the merchant

Example: {"orderId":"1234567890","customerId":"1234567890"}

productIdstringRequired

The ID of the product to charge the customer for

Example: 1234567890

productNamestringRequired

The name of the product to charge the customer for

Example: Product Name

productDescriptionstringRequired

The description of the product to charge the customer for

Example: Product Description

allowedAssetsstring · enumRequired

The allowed assets for the checkout session. If empty, all assets will be allowed.

Example: ["ETH","USDT","USDC"]Possible values:

Responses

200

The checkout session

application/json

post

/api/v1/checkout

HTTPcURLJavaScriptPython

POST /api/v1/checkout HTTP/1.1
Host: stage-capi.wewireafrica.com
Content-Type: application/json
Accept: */*
Content-Length: 361

{
  "amount": 100,
  "currency": "USD",
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel",
  "email": "[email protected]",
  "name": "John Doe",
  "metadata": {
    "orderId": "1234567890",
    "customerId": "1234567890"
  },
  "productId": "1234567890",
  "productName": "Product Name",
  "productDescription": "Product Description",
  "allowedAssets": [
    "ETH",
    "USDT",
    "USDC"
  ]
}

200

The checkout session

{
  "url": "text"
}

Get a checkout session by ID

get

https://stage-capi.wewireafrica.comhttps://capi.wewireafrica.com

/api/v1/checkout/sessions/{id}

Authorizations

bearerww-api-key

Path parameters

idstringRequired

Checkout session ID

Responses

200

The checkout session

application/json

get

/api/v1/checkout/sessions/{id}

HTTPcURLJavaScriptPython

GET /api/v1/checkout/sessions/{id} HTTP/1.1
Host: stage-capi.wewireafrica.com
Accept: */*

200

The checkout session

{
  "id": "text",
  "currency": "text",
  "amount": 1,
  "email": "text",
  "name": "text",
  "productId": "text",
  "productName": "text",
  "productDescription": "text",
  "allowedAssets": [
    "text"
  ],
  "expiresAt": "text",
  "metadata": {},
  "customerId": "text",
  "redirectUrl": "text",
  "cancelUrl": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "customer": {}
}

Expire a checkout session

post

https://stage-capi.wewireafrica.comhttps://capi.wewireafrica.com

/api/v1/checkout/{id}/expire

Authorizations

bearerww-api-key

Path parameters

idstringRequired

Checkout session ID

Responses

201

201 response

post

/api/v1/checkout/{id}/expire

HTTPcURLJavaScriptPython

POST /api/v1/checkout/{id}/expire HTTP/1.1
Host: stage-capi.wewireafrica.com
Accept: */*

201

201 response

No content

Cancel a checkout session

post

https://stage-capi.wewireafrica.comhttps://capi.wewireafrica.com

/api/v1/checkout/{id}/cancel

Authorizations

bearerww-api-key

Path parameters

idstringRequired

Checkout session ID

Responses

201

201 response

post

/api/v1/checkout/{id}/cancel

HTTPcURLJavaScriptPython

POST /api/v1/checkout/{id}/cancel HTTP/1.1
Host: stage-capi.wewireafrica.com
Accept: */*

201

201 response

No content