Claim Payment

POST

/payments/{id}/claim

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠401

🟠404

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location '/payments//claim' \
--header 'Idempotency-Key;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "reference": "string",
    "receipt": {
        "url": "string",
        "name": "string"
    }
}'

Response Example

200 - Example 1

{
    "data": {
        "id": "string",
        "type": "string",
        "requested": {
            "amount": "string",
            "currency": "string"
        },
        "initialized": {
            "amount": "string",
            "currency": "string"
        },
        "processed": {
            "amount": "string",
            "currency": "string"
        },
        "refunded": {
            "amount": "string",
            "currency": "string"
        },
        "requisite": {
            "type": "card",
            "card": "string",
            "holder": "string",
            "bank": "string"
        },
        "status": "string",
        "reason_code": "string",
        "expires_at": "string",
        "created_at": "string",
        "finalized_at": "string",
        "metadata": {}
    }
}

Retrieve Payment

Cancel Payment