BAbanqzinc
Embedded

Update an embedded payment request (amount and/or rewards) before payment initiation

Changed on

Update an embedded payment request (amount and/or rewards) before payment initiation

patch/api/v1/embedded/payment-requests

Request

Request body

merchant_idstring uuid

Merchant ID. Defaults to the logged-in merchant if not provided. Required for admin tokens.

payment_tokenstring required

Payment token identifying the request to update

amountinteger

Minor-unit amount (e.g. cents)

Example request

{
  "merchant_id": "550e8400-e29b-41d4-a716-446655440000",
  "payment_token": "ptok_abcd1234",
  "amount": 1530,
  "rewards": {
    "extra_rewards": 150,
    "total_rewards": 300,
    "description": "Updated loyalty bonus"
  }
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "payment_token": "ptok_abcd1234",
    "amount": 1530,
    "rewards": {
      "extra_rewards": 150,
      "total_rewards": 300,
      "description": "Updated loyalty bonus"
    },
    "expires_in": 750
  }
}

Changes

  • b372e7d5563dRevision changes
    • breaking

      the / response's property type changed from string to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

  • 6637b341d86dRevision changes
    • info

      endpoint added