v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

Get Payout Details

Use this call to retrieve the data of one of your payouts.

get/payout/{externalReference}

Path parameters

externalReferencestring required

Headers

Ocp-Apim-Subscription-Keystring required

The subscription key has a length of 32 characters and will be provided within the API keys. Will be available for new integrations from July 24th onwards.

Response

200

payoutIdinteger

payoutBatchIdinteger

{"stackTrail":"paths:/payout/{externalReference}:get:responses:200:content:application/json:schema:properties:payoutBeneficiaryTypeCode","oasType":"schema","type":"unknown"}

beneficiaryFirstNamestring

beneficiaryLastNamestring

documentTypestring

documentNumberstring

emailstring

currencyCodestring

countrystring

bankNamestring

accountAgencyNumberstring

accountNumberstring

{"stackTrail":"paths:/payout/{externalReference}:get:responses:200:content:application/json:schema:properties:abaSwift","oasType":"schema","type":"unknown"}

amountstring

addressstring

citystring

{"stackTrail":"paths:/payout/{externalReference}:get:responses:200:content:application/json:schema:properties:gender","oasType":"schema","type":"unknown"}

paymentReasonstring

{"stackTrail":"paths:/payout/{externalReference}:get:responses:200:content:application/json:schema:properties:errorReason","oasType":"schema","type":"unknown"}

statusTypeCodestring

payoutAccountTypeCodestring

externalReferencestring

notificationUrlstring

phonestring

{"stackTrail":"paths:/payout/{externalReference}:get:responses:200:content:application/json:schema:properties:testMode","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/payout/{externalReference}:get:responses:200:content:application/json:schema:properties:termsApproved","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/payout/{externalReference}:get:responses:200:content:application/json:schema:properties:testModeCallBackStatus","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/payout/{externalReference}:get:responses:200:content:application/json:schema:properties:recipientPixKey","oasType":"schema","type":"unknown"}

payoutChannelstring

Example response

{
  "payoutId": 2101122,
  "payoutBatchId": 23,
  "beneficiaryFirstName": "John",
  "beneficiaryLastName": "Doe",
  "documentType": "1",
  "documentNumber": "12345678901",
  "email": "test@test.com",
  "currencyCode": "BRL",
  "country": "BR",
  "bankName": "341",
  "accountAgencyNumber": "0001",
  "accountNumber": "8585",
  "amount": "1000.00",
  "address": "Address 1",
  "city": "City 1",
  "paymentReason": "Reason 2",
  "statusTypeCode": "PENDING",
  "payoutAccountTypeCode": "0001",
  "externalReference": "Reference 1",
  "notificationUrl": "https://yournotification.url.com",
  "phone": "55123456789",
  "payoutChannel": "ONLINE"
}