Retrieve transaction

DeveloperDocumentations for the Ratepay APIs and services.

DeveloperDocumentations for the Ratepay APIs and services.

Before you start

What is Ratepay

Payment methods

Integration options

Payment integration

Direct API integration

Payment API 2.0

Integration overview

Example requests

Transaction management

Authorize transaction

Retrieve transaction

Change transaction

Incremental authorization

Cancellation

Capture

Shipping information

Refund

Decline Categories

In-depth knowledge

Payment API 1.8

Shop Modules

PSP's & Marketplaces

Services

Authentication API

Pay Later API

Bank Account Management API

Transaction Status API

Miscellaneous

Regular customers

Device Fingerprinting

Data exchange via SFTP

ORCAWith ORCA you are able to see transactions, submit service requests and download reports about purchase orders and settlements.

ReportingStart with processing Settlement files, clearing files, merchant invoices and submitting regular customers.

LogosWelcome to Europe’s number one White Label payment provider. Here you can get more infos about our corporate identity.

LegalGet ready with the topics of the Ratepay Legal ABC.

Retrieve transaction

Retrieve attributes of an existing transaction including list of follow-up operations.

SecurityBearer Authentication

Request

path Parameters

ratepay_transaction_id

required

string

ID of transaction to retrieve. Get an overview of key identifiers used in payment API.

header Parameters

Prefer

string

According to RFC 7240: Provide return=representation if you prefer that the response to a request includes the current state of the resource.

Value: "return=representation"

Responses

200

Transaction retrieved

400

Bad request

404

Transaction not found

451

Legally not allowed

500

Technical problem

get/v2/transactions/{ratepay_transaction_id}

Request samples

curl
JavaScript
Java
Python

Response samples

200
400
404
451

application/hal+json

{"_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": "2024-10-08T13:34:10.205+02:00",
"created": "2019-08-24T14:15:22Z",
"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"
}