Search

Are you looking for test card numbers?

Would you like to contact support?

Default icon

Payment lifecycle

Learn how you can identify when a payment has been processed, captured, or refunded.

Each payment on the Balance Platform will go through a series of events during the payment lifecycle. Most of the events are triggered by the processing merchant, the business who processed the card payment.

Each event will result in a creation of the associated resource and updates on the status of the original payment. These events include:

Original payment

A payment attempt using an Adyen-issued creates a balancePlatform.Payment object.

An authorised payment will result in a hold being placed on the associated balanceAccount. You will see this hold on the balance account's transactions, indicated by a transaction.type.

You will be informed of the payment creation in a balancePlatform.payment.created notification.

{
  "type":"balancePlatform.payment.created",
  "platform":"test",
  "notification":{
    "id":"BPP1234123412341234",
    "amount":{
      "currency":"EUR",
      "value":1500
    },
    "status":"AUTHORISED",
    "pspReference":"9915717338410470",
    "createdAt":"2019-11-17T09:00:00",
    "balanceAccount":{
      "id":"BA1234123412341234"
    },
    "paymentInstrument":{
      "id":"PI1234123412341234"
    },
    "processingData":{
      "merchantInformation":{
        "mcc":"7999",
        "merchantId":"526567789012346",
        "city":"Amsterdam",
        "country":"NLD",
        "name":"MC Test Merchant Ref m",
        "rawData":"MC Test Merchant Ref m Amsterdam     NLD",
        "acquirerInstitutionIDCode":"013445",
        "forwardingInstitutionIDCode":"200353"
      },
      "validationResult":{
        "sanctionScreening":"valid",
        "cvc":"valid",
        "cardExpiration":"valid",
        "avsStreet":"valid",
        "avsPostalCode":"valid"
      }
    },
    "reference":"myBalancePlatformPayment_12345"
  }
}

The status of the original payment will be updated as further actions such as capture and refunds are performed by the processing merchant.

You can add or update a limited set of information in a payment, such as your own reference or metadata.

Captures

When the processing merchant has captured the payment, we will create a capture object, and inform you of the event through a webhook.

A capture can be a smaller or up to the amount of the original payment. The capture may only be greater than the original payment if you have set settings.captureAmountOverAuth to a value greater than zero.

The capture will deduct the funds from the balanceAccount. If all of the original payment amount has been captured, then the hold placed on the balance account will be removed.

You can also query a capture by its id with an HTTP GET request.

{
    "id":"CA1234123412341234",
    "originalPayment":{
        "id":"BPP1234123412341234"
    },
    "amount":{
      "currency":"EUR",
      "value":1500
    },
    "pspReference" : "8915817838815480",
    "createdAt":"2019-11-17T10:00:00",
    "balanceAccount":{
      "id":"BA1234123412341234"
    },
    "paymentInstrument":{
      "id":"PI1234123412341234"
    },
    "reference":"myBalancePlatformCapture_12345"
  }

Refunds

When the processing merchant has refunded the payment, we will create a refund object, and inform you of the event through a webhook.

A refund can be any amount, but usually an amount equivalent to the payment amount. We will link the refund to the original payment and capture whenever possible. Since the card networks don't require refunds to be referenced, linking the refund to a payment or capture is not guaranteed.

The refund will result in a credit to the balanceAccount.

You can also query a refund by its id with an HTTP GET request.

{
    "id":"RF1234123412341234",
    "originalPayment":{
      "id":"BPP1234123412341234"
    },
    "originalCapture":{
      "id":"CA1234123412341234"
    },
    "amount":{
      "currency":"EUR",
      "value":1500
    },
    "pspReference" : "3915717878735473",
    "createdAt":"2019-11-17T11:00:00",
    "balanceAccount":{
      "id":"BA1234123412341234"
    },
    "paymentInstrument":{
      "id":"PI1234123412341234"
    },
    "reference":"myBalancePlatformCapture_12345"
  }

Next steps