Pay Order

Process payment for an existing order.

Payment Workflow

Payment processing follows this workflow:

Create Order: First create an order using POST /orders (status: placed)

Submit Payment: Call this endpoint with payment details (card or bank account)

Payment Processing: The payment is processed with status processing

Payment Result:

Success: Payment status becomes succeeded, order status updates to approved

Failure: Payment status becomes failed, order remains placed and can be retried

Receipt: After successful payment, retrieve the receipt from the order details

Important: This is a synchronous payment operation. For security, sensitive payment data (like CVC codes) are writeOnly and never returned in responses. Card numbers and account numbers are masked when read.

Request

Authorization

OAuth 2.0

Authorization Code

deviceCode

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://auth.petstoreapi.com/authorize

Token URL: https://auth.petstoreapi.com/token

Refresh URL: https://auth.petstoreapi.com/refresh

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Examples

curl --location --request POST '/orders/123456/payment' \ --header 'Content-Type: application/json' \ --data-raw '{ "amount": 49.99, "currency": "GBP", "source": { "object": "card", "name": "J. Doe", "number": "4242424242424242", "cvc": "123", "expMonth": 12, "expYear": 2025, "addressLine1": "123 Fake Street", "addressLine2": "4th Floor", "addressCity": "London", "addressCountry": "gb", "addressPostCode": "N12 9XX" } }'

{ "id": "2e3b4f5a-6b7c-8d9e-0f1a-2b3c4d5e6f7a", "amount": 49.99, "currency": "GBP", "source": { "object": "card", "name": "J. Doe", "number": "************4242", "cvc": "123", "expMonth": 12, "expYear": 2025, "addressCountry": "gb", "addressPostCode": "N12 9XX" }, "status": "succeeded", "links": { "order": "https://api.example.com/orders/1725ff48-ab45-4bb5-9d02-88745177dedb/payment" } }

Payment Workflow#

Request

Responses

Payment Workflow