Settle Amount

Sandbox Env

POST

/customers/43278243803/settlements

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params application/json

Example

{
    "externalIdentifier": "{{$randomUUID}}",
    "amount": 70.00,
    "currency": "BRL",
    "paymentMethod": "PIX",
    "customer": {
        "documentNumber": "43278243803",
        "firstName": "Iago",
        "lastName": "Senefonte"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/customers/43278243803/settlements' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalIdentifier": "{{$randomUUID}}",
    "amount": 70.00,
    "currency": "BRL",
    "paymentMethod": "PIX",
    "customer": {
        "documentNumber": "43278243803",
        "firstName": "Iago",
        "lastName": "Senefonte"
    }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": "669a99c81482bf548bb723f4",
    "externalIdentifier": "8bb33b7d-dadf-4eb7-8803-16de19fd40e6",
    "amount": 1,
    "currency": "BRL",
    "message": null,
    "status": "COMPLETED",
    "createdAt": "2024-07-19T13:52:24.704Z",
    "processedAt": null
}

Modified at 2024-07-24 14:00:47

New Withdrawal

Process Remittance