Create a donation

POST

/donate

Schedules a new payment to be created (including a new authorisation request) for the specified donation using the payment details of the original payment.

This endpoint is part of our classic API integration. If using a newer integration, use the /donations endpoint under Checkout API instead.

Request

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 Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/donate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "donationAccount": "string",
    "merchantAccount": "string",
    "modificationAmount": {
        "currency": "str",
        "value": 0
    },
    "originalReference": "string",
    "platformChargebackLogic": {
        "behavior": "deductAccordingToSplitRatio",
        "costAllocationAccount": "string",
        "targetAccount": "string"
    },
    "reference": "string"
}'

Response Example

200 - Example 1

{
    "additionalData": {
        "property1": "string",
        "property2": "string"
    },
    "pspReference": "string",
    "response": "[capture-received]"
}

Modified at 2023-08-15 08:20:06

Capture an authorisation

Refund a captured payment