Returns all payouts that meet the specified parameters (if any) and that are associated with the Nexio account used to authenticate.
This is the only endpoint where you can use payoutRef in the request to view a specific payout based on that value.
You may also request to return additional parameters and/or filter results using one or more query parameters.
📘
Notes
By way of example, to return (filter) all payouts where the currency is EUR and also (request to include) the recipientIdNumbers object in the response, the request would look like this: /payout/v3?recipientIdNumbers.¤cy=EUR
To return (filter) only the payout with the specified payoutRef parameter, the request would look like this: /payout/v3?payoutRef=dfbb8efc-6e85-4973-8f2e-69baf8624ae6
For a more detailed tutorial, see the query parameters section of Guides.
⚠️
Try It
To use the Try It feature for this endpoint, you must use your own Sandbox credentials.
Request parameters
addressLine1
addressLine2
addressType
amount
batchRef
birthDate
city
country
countryOfBirth
countryOfNationality
currency
description
email
endDate
firstName
gender
governmentIdType
id
limit
mobileNumberCountry
offset
payoutAccountId
payoutProviderAdditionalRef
payoutProviderRef
payoutRef
payoutStatus
phoneNumber
phoneNumberCountry
postalCode
providerId
providerRecipientRef
providerResponse
providerType
recipientId
recipientIdNumbers
recipientIdNumbers.governmentId
recipientIdNumbers.passportId
recipientIdNumbers.employerId
recipientIdNumbers.driversLicenseId
recipientRef
region
startDate
transferStatus
updatedAt
userType
createdAt
lastName
mobileNumber
payoutDate
Response parameters
offset
limit
rows
rows.batchRef
rows.id
rows.recipientRef
rows.recipientId
rows.payoutAccountId
rows.payoutRef
rows.providerId
rows.providerType
rows.payoutProviderRef
rows.payoutProviderAdditionalRef
rows.providerRecipientRef
rows.amount
rows.currency
rows.description
rows.payoutDate
rows.transferStatus
rows.payoutStatus
rows.providerResponse
rows.firstName
rows.lastName
rows.addressLine1
rows.addressLine2
rows.city
rows.region
rows.postalCode
rows.country
rows.email
rows.phoneNumber
rows.mobileNumber
rows.createdAt
rows.updatedAt
hasMore
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!