Sign in
Spendbacks

Spendback refund

Allows the merchant to refund recipients who have previously made a spendback transaction.

<!-- 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 spendback ID and amount to refund in the request.

<div style="display:none;">

Request parameters

  • spendbackId
  • amount
  • payoutAccountId
  • recipientId
  • providerId
  • spendbackRef
  • recipientRef
  • providerSpendbackRef
  • currency
  • providerType
  • spendbackType
  • spendbackStatus
  • spendbackDate
  • createdAt
  • updatedAt

Response parameters

  • spendbackId
  • payoutAccountId
  • recipientId
  • providerId
  • spendbackRef
  • recipientRef
  • providerSpendbackRef
  • amount
  • currency
  • providerType
  • spendbackType
  • spendbackStatus
  • spendbackDate
  • createdAt
  • updatedAt
</div>
post/payout/v3/spendbackRefund

Request body

spendbackIdinteger required

The ID value auto-generated by Nexio when the spendback request was submitted (see the Submit spendback endpoint).

amountnumber required

The payout amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.

payoutAccountIdinteger

The Nexio ID for the payout account. Useful for identifying the business or business segment associated with the recipient.

recipientIdinteger

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

providerIdProviderId — unresolved $ref
spendbackRefstring

Reference value for the spendback request. This allows for easier synchronization and searching across different systems.

recipientRefstring

Payer's unique reference value for the recipient. This allows for easier synchronization and searching across different systems. This is the same recipientRef that is used in the Submit spendback endpoint and is a unique value used for spendbacks.

providerSpendbackRefstring

Reference value for the spendback from the payout provider. This allows for easier synchronization and searching across different systems.

currencyCurrency — unresolved $ref
providerType10 | 20 | 30 | 40 | 50 | 60

The Nexio ID for the payout provider used to process the spendback request.

Possible values include the following:

  • 10 - Interchecks
  • 20 - Hyperwallet
  • 30 - Payquicker
  • 40 - Nexio's mock payout provider for quicker sandbox integration
  • 50 - MassPay
  • 60 - Nomad
spendbackType10 | 20

The type of spendback used.

10 is spendback and 20 is refund.

spendbackStatus10 | 20 | 30 | 40 | 50 | 90

The status of the spendback, returned as an integer. For more information about possible values, see the spendbackStatus table.

spendbackDatestring date

The date the spendback request was sent to the provider, formatted as an ISO-8601 date expressed in UTC.

updatedAtstring

The date and time the spendback record was most recently updated in Nexio, formatted as an ISO-8601 date expressed in UTC.

createdAtstring

The date and time the spendback request was sent to the provider, formatted as an ISO-8601 date expressed in UTC.

Response

OK

spendbackIdSpendbackId — unresolved $ref
payoutAccountIdPayoutAccountId — unresolved $ref
recipientIdRecipientId — unresolved $ref
providerIdProviderId — unresolved $ref
spendbackRefSpendbackRef — unresolved $ref
recipientRefstring

Your unique identifier for a recipient. This is the payer account used for the spendback.

providerSpendbackRefProviderSpendbackRef — unresolved $ref
amountAmount — unresolved $ref
currencystring

The three-character ISO currency code for the spendback by the specified payer.

providerTypeProviderType — unresolved $ref
spendbackTypeSpendbackType — unresolved $ref
spendbackStatusSpendbackStatus — unresolved $ref
spendbackDateSpendbackDate — unresolved $ref
updatedAtUpdatedAt — unresolved $ref
createdAtCreatedAt — unresolved $ref

Changes

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