Adyen Checkout API
  1. Orders
Adyen Checkout API
  • Modifications
    • Cancel an authorised payment
      POST
    • Update an authorised amount
      POST
    • Cancel an authorised payment
      POST
    • Capture an authorised payment
      POST
    • Refund a captured payment
      POST
    • Refund or cancel a payment
      POST
  • Payments
    • Get the list of brands on the card
      POST
    • Start a transaction for donations
      POST
    • Get a list of available payment methods
      POST
    • Start a transaction
      POST
    • Submit details for a payment
      POST
    • Create a payment session
      POST
  • Orders
    • Create an order
      POST
    • Cancel an order
      POST
    • Get the balance of a gift card
      POST
  • Utility
    • Get an Apple Pay session
      POST
    • Create originKey values for domains
      POST
  • Payment links
    • Create a payment link
      POST
    • Get a payment link
      GET
    • Update the status of a payment link
      PATCH
  • Classic Checkout SDK
    • Create a payment session
      POST
    • Verify a payment result
      POST
  1. Orders

Get the balance of a gift card

POST
/paymentMethods/balance
Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST /paymentMethods/balance call and include the gift card's details inside a paymentMethod object.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK - the request has succeeded.
application/json
Body

🟠400Bad Request - a problem reading or understanding the request.
🟠401Unauthorized - authentication required.
🟠403Forbidden - insufficient permissions to process the request.
🟠422Unprocessable Entity - a request validation error.
🔴500Internal Server Error - the server could not process the request.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/paymentMethods/balance' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example
200 - Example 1
Modified at 2023-08-15 09:16:27
Previous
Cancel an order
Next
Get an Apple Pay session
Built with