Download payout proof of payment

get

https://api.checker.finance/v1/payments/withdrawals/{withdrawal_id}/proof-of-payment

PDF proof of payment for a COMPLETED CHINA_OFFRAMP or HONG_KONG_OFFRAMP payout. Choose the document with type. Errors are JSON. The document contains beneficiary details; do not cache or share it publicly.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

withdrawal_id

string

required

Query Params

type

string

enum

Defaults to CONFIRMATION

Document to download. CONFIRMATION: payment confirmation (default). MT103: SWIFT MT103 copy. CFXPS: cross-border FX payment slip. Case-sensitive. A type not available for the payout returns 409 PROOF_OF_PAYMENT_NOT_AVAILABLE.

Allowed:

Headers

X-Api-Key

string

required

X-Timestamp

string

required

Current UTC time, RFC 3339; within 5 minutes of server time.

X-Nonce

string

required

Fresh value per request (e.g. a UUID). Not signed.

X-Signature

string

required

Lowercase hex HMAC-SHA256, keyed with your API secret, of {METHOD}\n{path}\n{query}\n{X-Timestamp}\n{body}. query excludes ?; empty query/body are empty strings (multipart uploads sign an empty body).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/pdf

application/json

200The requested proof of payment.

400VALIDATION_ERROR: malformed withdrawal_id, or type is not CONFIRMATION, MT103 or CFXPS.

401UNAUTHORIZED: missing, invalid or expired signature.

404NOT_FOUND, including another tenant's resources.

409PROOF_OF_PAYMENT_NOT_AVAILABLE: the payout is not COMPLETED, or the requested type is not available for it.

422OPERATION_NOT_SUPPORTED: no proof of payment on this rail. PROVIDER_ERROR: not retrievable.

503PROVIDER_UNAVAILABLE. Safe to retry.