Skip to content

Retrieve a Payout

Payment Status

Retrieve the payment status by idempotencyKey

HTTP Request

GET /v1/payments/payouts/key/{{idempotencyKey}}

Request Headers
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
Content-Type: application/json
    "statusCode": 200,
    "errorMsg": "",
    "idempotencyKey": "TestPixUSDTOBRL-20220822002",
    "targetName": "Joice M Santos Joice Mary Santos",
    "targetDocument": "11013601513",
    "targetPixKey": "11013601513",
    "targetPixKeyType": "document",
    "targetBankCode": "",
    "targetBankAgency": "",
    "targetBankAccountId": "",
    "amount": "1.00",
    "amountInCents": 100,
    "currency": "USD",
    "paidAmount": 314,
    "paidCurrency": "BRL",
    "exchangeRate": 5.067,
    "paidTax": 192,
    "createTime": "2022-08-22 02:02:52 GMT-07:00",
    "finalStatusTime": "2022-08-22 02:02:59 GMT-07:00",
    "transferStatus": "SETTLED",
    "transferStatusCode": 200,
    "transferErrorMsg": "",
    "subMerchantId": "UUID"

HTTP Headers Details

Key Value
Content-Type application/json
Accept application/json
Authorization "bearer"+ "" + {{access_token}}
x-api-key {{api_key}}

Response Body Details

Parameter Type Description
statusCode Integer 200 Success, 401 Access denied, 422 Required fields missing or invalid data, 500 internal error
errorMsg String Error message if failed
idempotencyKey String Unique key to ensure idempotent requests
targetName String Target account holder full name
targetDocument String Target account holder identity, CPF 11 digits
targetPixKey String Target PIX Key
targetPixKeyType String The type of target PIX key, enum value as email, phone, document or random
targetBankCode String Target Bank Code. three digits.
targetBankAgency String Target Bank Agency Code.
targetBankAccountId String Target Bank Account Id.
amount String DEPRECATED. The transfer amount. note: 1 = 1BRL. Please use amountInCents instead
amountInCents Long The transfer amount. note: 100 = 1BRL/1USD
currency String The currency code of the transferred fund. enum value as BRL, USD
paidAmount Long Null if input currency was BRL. The amount that beneficiary get paid in paidCurrency
paidCurrency String Null if input currency was BRL. The currency used to paid for beneficiary, BRL
exchangeRate Double Null if input currency was BRL. Exchange rate for payment if currency was not BRL
paidTax Long Null if input currency was BRL. Transfer fee for currency conversion
createTime String Payment record create time
finalStatusTime String Transfer final status update time, final status include SETTLED, FAILED and REJECTED
transferStatus String Transfer status, SETTLED, IN_PROGRESS, FAILED and REJECTED,We should use transferStatus to judge the payment status
transferStatusCode Integer Transfer status code, TransferErrorCode
transferErrorMsg String Transfer error message if failed
subMerchantId String The sub merchant ID
Back to top