Capture payments Copy section link Copied!

AgoraPay supports a two-step card payments were you first authorise a charge, then wait to capture (settle) it later. When a charge is authorised, the funds are guaranteed by the card issuer and the amount held on the customer's card.

For all card payments done as authorisation only (you set capture to 0), you have 75 days to make a capture request after the authorisation request. However, the 3DS guarantee is only available :

For 14 days for credit cards
For 6 days for Visa and Mastercard

After this delay, the payment is more likely to be unpaid. Also, the risk that the issuers decline the capture increases over time :

30 days for credit cards
8 days for VISA
10 or 90 days depending on the merchant's industry for Mastercard

From your server, make a /payin/capture request:

Parameter Name

Required

Type

Description

orderId

string

Order id obtained in order creation

transactionAmount

object

amount information

metaData

object

JSON data for the marketplace. This data is not used by payment systems.

breakdownList

array

transactionId

string

Id of the payment transaction.

Example Copy section link Copied!

Here is a JSON payload example:

JSON

Copy

Copied

{
    "orderId": "3343121",
    "transactionId": "1707621",
    "transactionAmount": {
        "value": "1000.20",
        "currency": "EUR"
    },
    "breakdownList": [
        {
            "label": "bdl1",
            "sellerAccountNumber": "1300600000EUR01006110",
            "amount": {
                "value": "1000",
                "currency": "EUR"
            },
            "commission": {
                "amount": "1.01",
                "account": "1300600000EUR01004110"
            }
        },
        {
            "label": "bdl2",
            "sellerAccountNumber": "1300600000EUR01007110",
            "amount": {
                "value": "0.20",
                "currency": "EUR"
            }
        }
    ]
}

Copy

Copied

Retrieving the result Copy section link Copied!

You can retrieve the transactionActionsResponse object, containing the following payload information:

Parameter Name

Type

Description

resultCode

string

resultCode of the processing

orderStatus

string

transactionList

array

List of transaction for the order

resultCodeMessage

string

orderId

string

Example of response Copy section link Copied!

Here is a successful response JSON payload example:

JSON

Copy

Copied

{
    "resultCode": "0",
    "orderId": "3343121",
    "orderStatus": "partial_complete",
    "transactionList": [
        {
            "id": "1707621",
            "type": "7",
            "paymentMethodId": "36",
            "status": "completed",
            "amount": {
                "value": "1103.28",
                "currency": "EUR"
            }
        },
        {
            "id": "1707721",
            "type": "1",
            "paymentMethodId": "36",
            "status": "completed",
            "amount": {
                "value": "1000.20",
                "currency": "EUR"
            }
        }
    ]
}

Copy

Copied

Error handling Copy section link Copied!

If you encounter any error, you can check the following pages for troubleshooting:

List of API error codes