Initiate a spend back transaction

post https://{environment}.masspay.io/{VERSION}/payout/spendback/{user_token}

This POST endpoint is used to initiate a spendback transaction to a provided user token.
You can use this endpoint to enable spendback transactions for your users and help them manage their funds more effectively.
To use this endpoint, you need to provide the user_token as a parameter in the URL Path, along with the required parameters in the request Body, including client_spendback_id, source_token, source_currency_code and amount.
The endpoint will then initiate the spendback transaction, transferring funds from the source token to the user token. The response will contain a JSON object indicating the status of the request and any relevant transaction details.

Path Params

user_token

string

required

Token representing the user to fetch/initiate spend back

Body Params

Spend back information

client_spendback_id

string

required

length ≤ 50

A client defined spend back identifier. This is the unique ID assigned to the load on your system. Max 50 characters.

source_token

uuid

required

Token that represents the funding source i.e. bank account, wallet. 36 characters long

source_currency_code

string

required

Defaults to USD

The currency originating balance is stored in. Using ISO 4217 format. In most cases this value will be USD, and therefore the defaut value if none is provided

amount

number

required

The amount to debit the user's wallet in source currency

notes

string

length ≤ 255

A description for the spend back

metadata

object

Optional JSON object with attributes that can later be searched to locate this spendback. Do not include PII as this object is not encrypted. There are two special attributes that can be provided in the metadata field: batch_identifier and batch_name. Either of those values, would group transactions in the ledger under the same description.

Headers

Idempotency-Key

string

Unique key to prevent duplicate processing

Responses

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.masspay.io/v1.0.0/payout/spendback/user_token \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "source_currency_code": "USD"
8
}
9
'


xxxxxxxxxx
 
1
{
2
  "spendback_token": "spnd_bk_123e4567-e89b-12d3-a456-426614174000",
3
  "client_spendback_id": "aEjn345",
4
  "status": "success",
5
  "metadata": {
6
    "group_id": 541
7
  }
8
}

201Succesfully created.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method Not Allowed.

500Internal server error.

504Gateway Time-out.