View a payout

get https://api.nexiopaysandbox.com/payout/v3/

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.

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