Create new purchase attempt.

​

This will create a purchase attempt and it will return a redirect url to the purchase attempt landing page please redirect the user to the redirect_url

Body
required
application/json
  • application_id
    Type: string · application id if not provided, it will be use the first application in the list
  • customer_redirect
    Type: object · Each purchase must have a customer redirect config. This is to redirect the customer to merchant website after BNPL process is completed or cancelled @ref `CustomerRedirect`
  • merchant_purchase_ref
    Type: string · identification of a unique purchase within the merchant system You can not have multiple attempts with the same merchant_purchase_ref
  • purchase_details
    Type: object · purchase details
  • transaction_flow_config
    Type: object · transaction flow config TODO: not supported yet
Responses
  • application/json
  • application/json
Request Example for post/v1/bnpl/attempt
curl /v1/bnpl/attempt \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "application_id": "",
  "merchant_purchase_ref": "",
  "customer_redirect": {
    "approved_url": "",
    "canceled_url": ""
  },
  "purchase_details": {
    "billing_address": {
      "person": {
        "first_name": "",
        "last_name": "",
        "other_names": "",
        "phone": "",
        "email": "",
        "national_id": ""
      },
      "address": {
        "country_code": "",
        "city": "",
        "postal_code": "",
        "street1": "",
        "street2": "",
        "country_region": "",
        "district": "",
        "block": "",
        "entrance": "",
        "floor": "",
        "apartment": ""
      }
    },
    "shipping_address": {
      "person": {
        "first_name": "",
        "last_name": "",
        "other_names": "",
        "phone": "",
        "email": "",
        "national_id": ""
      },
      "address": {
        "country_code": "",
        "city": "",
        "postal_code": "",
        "street1": "",
        "street2": "",
        "country_region": "",
        "district": "",
        "block": "",
        "entrance": "",
        "floor": "",
        "apartment": ""
      }
    },
    "customer": {
      "customer_ref": ""
    },
    "shopping_card": {
      "currency_code": "",
      "shipping_amount": "",
      "tax_amount": "",
      "total_amount": "",
      "discount_amount": "",
      "items": [
        {
          "title": "",
          "image_url": "",
          "item_url": "",
          "sku": "",
          "item_version": "",
          "qty": "",
          "unit_price": ""
        }
      ]
    }
  },
  "transaction_flow_config": {
    "transaction_capture": "TRANSACTION_CAPTURE_UNSPECIFIED"
  }
}'

{
  "attempt_id": "string",
  "redirect_url": "string",
  "expiration_time": "2026-04-02T14:45:59.065Z"
}

A successful response.