Sign in
Spendbacks

Submit spendback

Allows you to submit a spendback in the body of an API request.

A spendback request can only be made for an existing recipient and you can only process one spendback at a time.

Required parameters

Each spendback request must include the amount and currency parameters as well as one of the following recipient parameters (if you specify more than one, they are prioritized in the given order):<br/>    - recipientId<br/>    - recipientRef<br/>    - email

<!-- 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 at least the amount and currency parameters, along with one of the recipient parameters (see above).

<div style="display:none;">

Request parameters

  • recipientId
  • recipientRef
  • email
  • amount
  • currency
  • description
  • spendbackRef
  • providerId

Response parameters

  • id
  • spendbackRef
  • recipientId
  • recipientRef
  • payoutAccountId
  • providerId
  • providerType
  • providerSpendbackRef
  • amount
  • currency
  • description
  • spendbackDate
  • spendbackStatus
  • providerResponse
  • createdAt
  • updatedAt
</div>
post/payout/v3/spendback

Request body

OR
OR

Response

OK

idinteger

The ID value auto-generated by Nexio when the spendback request was submitted.

spendbackRefSpendbackRef — unresolved $ref
recipientIdinteger

The Nexio-generated ID for a recipient. This is the payer account used for the spendback.

recipientRefRecipientRef — unresolved $ref
payoutAccountIdPayoutAccountId — unresolved $ref
providerIdinteger

The Nexio ID for the provider. Indicates a specific set of payout provider credentials that were used to process a spendback request.

providerTypeProviderType — unresolved $ref
providerSpendbackRefProviderSpendbackRef — unresolved $ref
amountnumber

The spendback amount refunded. For testing purposes with the Mock Payout account, you can trigger an error by sending amount with a value of 12.34.

currencyCurrency — unresolved $ref
descriptionstring

Description information for the spendback. The system returns this parameter only when a value is provided for it in the Submit spendback request.

spendbackDateSpendbackDate — unresolved $ref
spendbackStatusSpendbackStatus — unresolved $ref
providerResponsestring

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

createdAtCreatedAt — unresolved $ref
updatedAtUpdatedAt — unresolved $ref

Changes

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