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):
    - recipientId
    - recipientRef
    - email

⚠️

Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

Include at least the amount and currency parameters, along with one of the recipient parameters (see above).

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