BYbyaccrue
PaymentIntents

Create a Payment Intent

Create a payment intent using amount and exactly one of walletId or lookUpId.

When walletId is provided, the wallet is validated for the request merchant.

When lookUpId is provided, the scanned string is resolved as a wallet barcode first; if no wallet barcode matches, it is resolved as a gift identifier. Never send a gift data.id as walletId. A wallet barcode lookUpId follows the wallet scan-and-pay flow.

Gift look-ups skip KYC. balance.available is the remaining spendable amount (gift remaining, or wallet available).

For a gift lookUpId, point-of-sale should first fetch remaining via Get Gift by lookUpId (/api/v1/gifts/{lookUpId}), then POST this endpoint with the same scanned string as lookUpId. Authorize returns a Payment whose links.virtualDebitCard is the gift virtual debit card. Gift remaining is spent later by card-present authorization of that card; authorize does not debit the gift reserve.

post/api/v1/payment-intents

Request

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Request body

Example request

{
  "data": {
    "attributes": {
      "amount": 3600,
      "walletId": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

Response

Created

Example response

{
  "data": {
    "attributes": {
      "balance": {
        "available": 1500,
        "eligibleReward": 500,
        "upperLimit": 103600
      },
      "amount": 3600,
      "reference": "MERCHANT-GENERATED-TOKEN",
      "status": "Promotable",
      "walletId": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.