RAratepay
Capture

Retrieve a capture

Retrieve a capture resource of an existing transaction including its attributes.

get/v2/transactions/{ratepay_transaction_id}/captures/{ratepay_capture_id}

Request

  • Base URL
    https://api-integration.ratepay.com/transaction/management
  • URL
    https://api-integration.ratepay.com/transaction/management/v2/transactions/{ratepay_transaction_id}/captures/{ratepay_capture_id}
  • Auth
    HTTP bearer

Path parameters

ratepay_transaction_idstring required

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

ratepay_capture_idstring required

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

Headers

Prefer'return=representation'

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

X-Partnerstring

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

Capture retrieved

OR

Example response

{
  "_links": {
    "self": {
      "href": "https://api-integration.ratepay.com/transaction/management/v2/transactions/scwBgARW-nE93I7_ywhp/captures/BFNpWnim6LUDFQA8x3VN"
    }
  },
  "ratepay_capture_id": "BFNpWnim6LUDFQA8x3VN"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.