PApayretailers

Get Payout Details

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

get/payout/{externalReference}

Request

  • Base URL
    https://api-sandbox.payretailers.com/payments/v2
  • URL
    https://api-sandbox.payretailers.com/payments/v2/payout/{externalReference}
  • Auth
    HTTP basic

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
payoutBeneficiaryTypeCodeunknown
beneficiaryFirstNamestring
beneficiaryLastNamestring
documentTypestring
documentNumberstring
emailstring
currencyCodestring
countrystring
bankNamestring
accountAgencyNumberstring
accountNumberstring
abaSwiftunknown
amountstring
addressstring
citystring
genderunknown
paymentReasonstring
errorReasonunknown
statusTypeCodestring
payoutAccountTypeCodestring
externalReferencestring
notificationUrlstring
phonestring
testModeunknown
termsApprovedunknown
testModeCallBackStatusunknown
recipientPixKeyunknown
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"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.