Skip to content

Transfers API v3 ‐ v4

Jump to bottom
jillingk edited this page Nov 7, 2023 · 1 revision

What's Changed

GET /transactions/{id}
Parameters:

Changed: id in path

Unique identifier of the transaction.

Return Type:

Changed response : 401 Unauthorized

Unauthorized - authentication required.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 403 Forbidden

Forbidden - insufficient permissions to process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 422 Unprocessable Entity

Unprocessable Entity - a request validation error.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 500 Internal Server Error

Internal Server Error - the server could not process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 200 OK

OK - the request has succeeded.

  • Changed content type : application/json

    New required properties:

    • accountHolder
    • balanceAccount

    New optional properties:

    • accountHolderId
    • balanceAccountId
    • counterparty
    • createdAt
    • reference

    • Added property accountHolder (object)

      • Property description (object)

        The description of the resource.

      • Property id (object)

        The unique identifier of the resource.

      • Property reference (object)

        The reference for the resource.

    • Added property balanceAccount (object)

    • Added property transfer (object)

      • Property id (object)

        The ID of the resource.

      • Property reference (object)

        The reference from the /transfers request. If you haven't provided any, Adyen generates a unique reference.

    • Deleted property accountHolderId (object)

      Unique identifier of the account holder.

    • Deleted property balanceAccountId (object)

      Unique identifier of the balance account.

    • Deleted property category (object)

      The category of the transaction indicating the type of activity.

      Possible values:

      • platformPayment: The transaction is a payment or payment modification made with an Adyen merchant account.

      • internal: The transaction resulted from an internal adjustment such as a deposit correction or invoice deduction.

      • bank: The transaction is a bank-related activity, such as sending a payout or receiving funds.

      • issuedCard: The transaction is a card-related activity, such as using an Adyen-issued card to pay online.

    • Deleted property counterparty (object)

    • Deleted property createdAt (object)

      The date the transaction was created.

    • Deleted property description (object)

      The description from the /transfers request.

    • Deleted property eventId (object)

      The PSP reference of the transaction in the journal.

    • Deleted property instructedAmount (object)

    • Deleted property paymentInstrumentId (object)

      The unique identifier of the payment instrument that was used for the transaction.

    • Deleted property reference (object)

      The reference from the /transfers request. If you haven't provided any, Adyen generates a unique reference.

    • Deleted property referenceForBeneficiary (object)

      The reference sent to or received from the counterparty.

    • Deleted property transferId (object)

      Unique identifier of the related transfer.

    • Deleted property type (object)

      The type of the transaction.

      Possible values: payment, capture, captureReversal, refund refundReversal, chargeback, chargebackReversal, secondChargeback, atmWithdrawal, atmWithdrawalReversal, internalTransfer, manualCorrection, invoiceDeduction, depositCorrection, bankTransfer, miscCost, paymentCost, fee

POST /transfers/{transferId}/returns
Return Type:

New response : 202 Accepted

Accepted - the request has been accepted for processing, but the processing has not been completed.

Changed response : 200 OK

OK - the request has succeeded.

  • Changed content type : application/json

    • Changed property status (object)

      The resulting status of the return.

      For example: authorised, booked, error.

Changed response : 401 Unauthorized

Unauthorized - authentication required.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 403 Forbidden

Forbidden - insufficient permissions to process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 422 Unprocessable Entity

Unprocessable Entity - a request validation error.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 500 Internal Server Error

Internal Server Error - the server could not process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

GET /grants
Return Type:

Changed response : 400 Bad Request

Bad Request - a problem reading or understanding the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 401 Unauthorized

Unauthorized - authentication required.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 403 Forbidden

Forbidden - insufficient permissions to process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 404 Not Found

Not Found - the payment was not found

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 422 Unprocessable Entity

Unprocessable Entity - a request validation error.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 500 Internal Server Error

Internal Server Error - the server could not process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

POST /grants
Return Type:

Changed response : 400 Bad Request

Bad Request - a problem reading or understanding the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 401 Unauthorized

Unauthorized - authentication required.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 403 Forbidden

Forbidden - insufficient permissions to process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 404 Not Found

Not Found - the payment was not found

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 422 Unprocessable Entity

Unprocessable Entity - a request validation error.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 500 Internal Server Error

Internal Server Error - the server could not process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

GET /grants/{id}
Return Type:

Changed response : 400 Bad Request

Bad Request - a problem reading or understanding the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 401 Unauthorized

Unauthorized - authentication required.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 403 Forbidden

Forbidden - insufficient permissions to process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 404 Not Found

Not Found - the payment was not found

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 422 Unprocessable Entity

Unprocessable Entity - a request validation error.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 500 Internal Server Error

Internal Server Error - the server could not process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

GET /transactions
Return Type:

Changed response : 401 Unauthorized

Unauthorized - authentication required.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 403 Forbidden

Forbidden - insufficient permissions to process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 422 Unprocessable Entity

Unprocessable Entity - a request validation error.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 500 Internal Server Error

Internal Server Error - the server could not process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

POST /transfers
Return Type:

Changed response : 403 Forbidden

Forbidden - insufficient permissions to process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 422 Unprocessable Entity

Unprocessable Entity - a request validation error.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 500 Internal Server Error

Internal Server Error - the server could not process the request.

  • Changed content type : application/json

    • Changed property response (object)

      JSON response payload.

Changed response : 200 OK

OK - the request has succeeded.

  • Changed content type : application/json

    • Added property categoryData (object)

      The relevant data according to the transfer category.

    • Deleted property balanceAccountId (object)

      The unique identifier of the source balance account.

    • Deleted property paymentInstrumentId (object)

      The unique identifier of the payment instrument used in the transfer.

    • Deleted property priority (object)

      The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with category bank.

      Possible values:

      • regular: For normal, low-value transactions.

      • fast: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.

      • wire: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.

      • instant: Instant way to transfer funds in SEPA countries.

      • crossBorder: High-value transfer to a recipient in a different country.

      • internal: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). This will be removed in v4 and replaced with a new field.

Changed response : 202 Accepted

Accepted - the request has been accepted for processing, but the processing has not been completed.

  • Changed content type : application/json

    • Added property categoryData (object)

      The relevant data according to the transfer category.

    • Deleted property balanceAccountId (object)

      The unique identifier of the source balance account.

    • Deleted property paymentInstrumentId (object)

      The unique identifier of the payment instrument used in the transfer.

    • Deleted property priority (object)

      The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with category bank.

      Possible values:

      • regular: For normal, low-value transactions.

      • fast: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.

      • wire: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.

      • instant: Instant way to transfer funds in SEPA countries.

      • crossBorder: High-value transfer to a recipient in a different country.

      • internal: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). This will be removed in v4 and replaced with a new field.

Clone this wiki locally