Payouts

View a payout

Searches for payouts with the given payoutId.

📘 Note

The payoutId parameter is not the same as the payoutRef, payoutProviderRef, or payoutProviderAdditionalRef. To view a payout using one of these other reference values, use the View payouts endpoint.

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.<br/><br/>Include the payout ID in the path parameter of the request.

Request parameters

payoutId

Response parameters

batchRef
id
recipientRef
recipientId
payoutAccountId
payoutRef
providerId
providerType
payoutProviderRef
payoutProviderAdditionalRef
providerRecipientRef
amount
currency
description
payoutDate
transferStatus
payoutStatus
providerResponse
firstName
lastName
addressLine1
addressLine2
city
region
postalCode
country
email
phoneNumber
mobileNumber
createdAt
updatedAt

</div>

get/payout/v3/{payoutId}

Response

batchRefBatchRef — unresolved $ref

idId — unresolved $ref

recipientRefRecipientRef — unresolved $ref

recipientIdRecipientId — unresolved $ref

payoutAccountIdPayoutAccountId — unresolved $ref

payoutRefPayoutRef — unresolved $ref

providerIdProviderId — unresolved $ref

providerTypeProviderType — unresolved $ref

payoutProviderRefstring

Reference value for the payout from the payout provider.

payoutProviderAdditionalRefstring

Additional reference value for the payout that may be provided by the payout provider.

providerRecipientRefProviderRecipientRef — unresolved $ref

amountAmount — unresolved $ref

currencyCurrency — unresolved $ref

descriptionstring

Payer's description information for the payout to the specified recipient.

payoutDatestring date

The date the payout request was sent to the provider, formatted as an ISO-8601 date expressed in UTC.

transferStatus10 | 20 | 90

The status of the transfer, returned as an integer. For information about possible values, see the transferStatus table.

payoutStatus10 | 11 | 12 | 20 | 30 | 40 | 50 | 90

The status of the payout, returned as an integer. For more information about possible values, see the payoutStatus table.

providerResponsestring

Error message from the provider in case of a failed payout.

firstNameFirstName — unresolved $ref

lastNameLastName — unresolved $ref

addressLine1AddressLine1 — unresolved $ref

addressLine2AddressLine2 — unresolved $ref

cityCity — unresolved $ref

regionRegion — unresolved $ref

postalCodePostalCode — unresolved $ref

countryCountry — unresolved $ref

emailEmail — unresolved $ref

phoneNumberPhoneNumber — unresolved $ref

mobileNumberMobileNumber — unresolved $ref

createdAtCreatedAt — unresolved $ref

updatedAtUpdatedAt — unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.