NEnexiopay
Payouts

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.

<!-- theme: warning -->

⚠️ 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.

<div style="display:none;">

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
</div>
get/payout/v3/pending/{payoutId}

Request

  • Base URL
    https://api.nexiopaysandbox.com
  • URL
    https://api.nexiopaysandbox.com/payout/v3/pending/{payoutId}
  • Auth
    HTTP basic

Response

OK

idinteger

The ID value auto-generated by Nexio when the payout request was submitted. This value is the same as the payoutId parameter value.

recipientIdRecipientId (unresolved $ref)
payoutAccountIdPayoutAccountId (unresolved $ref)
recipientIdNumbersRecipientIdNumbers (unresolved $ref)
providerIdProviderId (unresolved $ref)
batchRefstring

Reference value for the batch request. If auto-generated by Nexio, the value includes "batch" and the date and time of the submit payout request as an ISO-8601 date, expressed in UTC.

payoutRefstring

Payer's unique reference value for a payout to the specified recipient. This allows for easier synchronization and searching across different systems.

recipientRefRecipientRef (unresolved $ref)
firstNameFirstName (unresolved $ref)
lastNameLastName (unresolved $ref)
emailEmail (unresolved $ref)
amountAmount (unresolved $ref)
currencyCurrency (unresolved $ref)
countrystring

The two-character (Alpha-2) ISO country code for the card.

providerTypeProviderType (unresolved $ref)
createdAtCreatedAt (unresolved $ref)
updatedAtUpdatedAt (unresolved $ref)

Changes

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