View payouts pending by ID

Allows the merchant to view specific payout transactions that have a pending status by using the payoutId to filter results.

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

  • id
  • recipientId
  • payoutAccountId
  • recipientIdNumbers
  • recipientIdNumbers.governmentId
  • recipientIdNumbers.passportId
  • recipientIdNumbers.employerId
  • recipientIdNumbers.driversLicenseId
  • providerId
  • batchRef
  • payoutRef
  • recipientRef
  • firstName
  • lastName
  • email
  • amount
  • currency
  • country
  • providerType
  • createdAt
  • updatedAt
  • events
  • events.type
  • events.params
  • events.params.providerId
Path Params
string
required

The id value auto-generated by Nexio when the payout request was submitted.

Responses

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json