Adyen Payment API
  1. Modifications
Adyen Payment API
  • Modifications
    • Change the authorised amount
      POST
    • Cancel an authorisation
      POST
    • Cancel or refund a payment
      POST
    • Capture an authorisation
      POST
    • Create a donation
      POST
    • Refund a captured payment
      POST
    • Cancel an authorisation using your reference
      POST
    • Cancel an in-person refund
      POST
  • General
    • Create an authorisation
      POST
    • Complete a 3DS authorisation
      POST
    • Complete a 3DS2 authorisation
      POST
    • Get the 3DS authentication result
      POST
    • Get the 3DS2 authentication result
      POST
  1. Modifications

Create a donation

POST
/donate
Modifications
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 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 Response Example
200 - Example 1
{
    "additionalData": {
        "property1": "string",
        "property2": "string"
    },
    "pspReference": "string",
    "response": "[capture-received]"
}

Request

Body Params application/json
donationAccount
string 
required
The Adyen account name of the charity.
merchantAccount
string 
required
The merchant account that is used to process the payment.
modificationAmount
object (Amount) 
required
The amount to be donated.The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.
currency
string 
required
The three-character ISO currency code.
>= 3 characters<= 3 characters
value
integer <int64>
required
The amount of the transaction, in minor units.
originalReference
string 
optional
The original pspReference of the payment to modify.
This reference is returned in:
authorisation response
authorisation notification
platformChargebackLogic
object (PlatformChargebackLogic) 
optional
Defines the behavior to be applied in case of a chargeback.
behavior
enum<string> 
optional
Allowed values:
deductAccordingToSplitRatiodeductFromLiableAccountdeductFromOneBalanceAccount
costAllocationAccount
string 
optional
targetAccount
string 
optional
reference
string 
optional
Your reference for the payment modification. This reference is visible in Customer Area and in reports.
Maximum length: 80 characters.
Examples

Responses

🟢200OK - the request has succeeded.
application/json
Body
additionalData
object 
optional
This field contains additional data, which may be returned in a particular modification response.
Additional properties
string 
optional
pspReference
string 
required
Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
response
enum<string> 
required
Indicates if the modification request has been received for processing.
Allowed values:
[capture-received][cancel-received][refund-received][cancelOrRefund-received][adjustAuthorisation-received][donation-received][technical-cancel-received][voidPendingRefund-received]
🟠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.
Modified at 2023-08-15 08:20:06
Previous
Capture an authorisation
Next
Refund a captured payment
Built with