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 your own Sandbox credentials.

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
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!