Retrieve transaction
Changed onRetrieve attributes of an existing transaction including list of follow-up operations.
Request
- Base URLhttps://api-integration.ratepay.com/transaction/management
- URLhttps://api-integration.ratepay.com/transaction/management/v2/transactions/{ratepay_transaction_id}
- AuthHTTP bearer
Path parameters
ID of transaction to retrieve. Get an overview of key identifiers used in payment API.
Headers
According to RFC 7240: Provide return=representation if you prefer that the response to a request includes the current state of the resource.
The partner ID for the operation is required only when using a single credential set for multiple integrations, such as countries or brands associated with one company.
Response
Transaction retrieved
Example response
{
"_links": {
"authorizations": [
{
"href": "https://api-integration.ratepay.com/transaction/management/v2/transactions/scwBgARW-nE93I7_ywhp/authorizations/9wdn0Fvkb9Zxsfiql5l6"
}
],
"cancellations": [
{
"href": "https://api-integration.ratepay.com/transaction/management/v2/transactions/scwBgARW-nE93I7_ywhp/cancellations/aa7rth5-__GG44rdsasf"
}
],
"captures": [
{
"href": "https://api-integration.ratepay.com/transaction/management/v2/transactions/scwBgARW-nE93I7_ywhp/captures/BFNpWnim6LUDFQA8x3VN"
}
],
"refunds": [
{
"href": "https://api-integration.ratepay.com/transaction/management/v2/transactions/scwBgARW-nE93I7_ywhp/refunds/9FkZsddr-MaFFFx7gAs_"
}
],
"self": {
"href": "https://api-integration.ratepay.com/transaction/management/v2/transactions/scwBgARW-nE93I7_ywhp"
}
},
"authorization_expires": "2025-04-02T16:15:18.823+02:00",
"decline": {
"category": "BUYER_DATA",
"reasons": [
"INVALID_BILLING_ADDRESS"
]
},
"payment_details": {
"deposit_bank_account": {
"bank_name": "Example Bank",
"bic": "EXBANKXXX",
"iban": "DE12345678901234567890",
"owner": "Ratepay GmbH"
},
"ratepay_payment_references": [
{
"partner_shop_id": "partner-shop-id-1",
"ratepay_payment_reference": "ET1285368M8"
}
]
},
"ratepay_transaction_id": "scwBgARW-nE93I7_ywhp",
"result": "ACCEPTED"
}Changes
- warning
added the new
COMPLIANCE_ATTESTATION_TOKEN_VALIDATION_FAILEDenum value to the//////response property for the response status - warning
added the new
COMPLIANCE_ATTESTATION_TOKEN_VALIDATION_FAILEDenum value to the//////response property for the response status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status
- warning
- breaking
the response property
/////became optional for the status - breaking
the response property
/////became optional for the status - breaking
the response property
/////became optional for the status - breaking
the response property
/////became optional for the status - breaking
the response property
//////became optional for the status - breaking
the response property
/////became optional for the status - breaking
the response property
/////became optional for the status - breaking
the response property
/////became optional for the status - breaking
the response property
/////became optional for the status
- breaking