Skip to content
Developer
/
/
/Shipping information

Payment OpenAPI Specification (version 2)

This is the documentation for the Ratepay Payment API v2. The API is still in development and subject to change. The documentation will evolve as the development of the API progresses.

Download OpenAPI description
payment_api.json
payment_api.yaml
Overview
URL

https://www.ratepay.com/

Ratepay

info@ratepay.com

Languages
Servers
Ratepay Integration Platform

https://api-integration.ratepay.com/transaction/management/

Ratepay Production Platform

https://api.ratepay.com/transaction/management/

Transaction management

Operations

Incremental authorization

Operations

Cancellation

Operations

Capture

Operations

Shipping information

Operations

Add shipping information

Request

Add shipping information to previously captured transaction

Security
Bearer Authentication
Path
ratepay_transaction_idstringrequired

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

ratepay_capture_idstringrequired

ID of capture the shipping information should be added to. Get an overview of key identifiers used in payment API.

Headers
Idempotency-Keystring<= 64 characters

ID generated by client to uniquely identify the request. It is highly recommended to use a UUID version 4. Do not reuse an idempotency key for different calls. See Idempotency for further details.

Preferstring

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"
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.

Bodyapplication/jsonrequired
carrier_namestringrequired

Name of carrier responsible for shipment.

Enum"DHL""POST_AUSTRIA""UPS""DPD""SWISS_POST""GLS""ASENDIA""HERMES_LOGISTICS""FEDEX""OTHER_WITH_TRACKING"
Example: "DHL"
tracking_numberstring[ 1 .. 127 ] characters

Tracking number for delivery. This field is mandatory for each carrier_name except: OTHER_WITHOUT_TRACKING

Example: "tracking-123456789"
curl -i -X POST \
  'https://api-integration.ratepay.com/transaction/management/v2/transactions/{ratepay_transaction_id}/captures/{ratepay_capture_id}/shipping-information' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -H 'Prefer: return=representation' \
  -H 'X-Partner: string' \
  -d '{
    "carrier_name": "DHL",
    "tracking_number": "tracking-123456789"
  }'

Responses

Shipping information added

Bodyapplication/hal+json
_linksobject(ShippingInformationLinks)required

Links related to the resource following specification by IANA.

_links.​selfobject(ShippingInformationSelfLink)required

The self relation identifying the shipping information resource itself.

_links.​self.​hrefstringrequired

URI pointing to resource itself.

Example: "https://api-integration.ratepay.com/transaction/management/v2/transactions/scwBgARW-nE93I7_ywhp/captures/BFNpWnim6LUDFQA8x3VN/shipping-information/HR1iyZYradbGbvOQzZ79"
createdstring(date-time)required

Timestamp with offset according to ISO 8601.

ratepay_shipping_information_idstring[ 20 .. 127 ] characters[A-Za-z0-9-_]{20,127}required

ID of added shipping information generated by Ratepay. Get an overview of key identifiers used in payment API.

Example: "HR1iyZYradbGbvOQzZ79"
Response
application/hal+json
{
  "_links": {
    "self": { … }
  },
  "created": "2019-08-24T14:15:22Z",
  "ratepay_shipping_information_id": "HR1iyZYradbGbvOQzZ79"
}

Refund

Operations