Introduction to MassPay REST API

Overview
Authentication
Idempotent Requests
Versioning
Webhooks
Swimlanes
Error codes
Data Migration
Testing

MassPay API

Account
Attribute
Card
- Get MassPay card informationget
- Update MassPay card informationput
Catalog
KYC
Load
Payout
Spend Back
- Get history of spend backs by user tokenget
- Initiate a spend back transactionpost
Tax
User
Wallet
Business
- Create a businesspost
- Update businesspatch

Introduction to MassPay REST API

Overview
Authentication
Idempotent Requests
Versioning
Webhooks
Swimlanes
Error codes
Data Migration
Testing

MassPay API

Account
Attribute
Card
- Get MassPay card informationget
- Update MassPay card informationput
Catalog
KYC
Load
Payout
Spend Back
- Get history of spend backs by user tokenget
- Initiate a spend back transactionpost
Tax
User
Wallet
Business
- Create a businesspost
- Update businesspatch

Store user attributes

post https://{environment}.masspay.io/{VERSION}/payout/attribute/{user_token}/{destination_token}/{currency}

This POST endpoint is used to store user attributes, allowing you to associate additional data with a user token.
To use this endpoint, you need to provide the user_token, destination_token, and currency as parameters in the URL Path. You also need to provide the attribute values as JSON parameters in the Request body.
If existing attributes are already stored for the user, this call will override their values.

URL Expired

The URL for this request expired after 30 days.

Path Params

user_token

string

required

Token representing the user to store attributes for

destination_token

string

required

Token that represents the payout destination i.e. MassPay->Brazil->Bank Deposit->Itau. To be retrieved from the #pricing callback.

currency

string

required

length between 3 and 4

The destination currency sending funds to. Using ISO 4217 format.

Body Params

Attr parameters to store

values

array of objects

required

values*

attr_set_token

string

The token that represents a set of attributes for a specific payer. Optional, specify the value if you're trying to update a value of a specific attributes set.

Headers

Idempotency-Key

string

Unique key to prevent duplicate processing

Responses

Response body

object

attr_set_token

string

required

attr_set_token associated with the stored attributes

Headers

object

Access-Control-Allow-Origin

string

Response body

object

title

string

Error title.

Bad request.

message

string

required

Error description.

The request was invalid or malformed. Please ensure that the request body conforms to the required format and that all required parameters are included.

code

integer

required

Error code.

400

error

object

reason

string

Reason for error

details

array of strings

Specific details of the cause of the error

details

Headers

object

Access-Control-Allow-Origin

string

Response body

object

title

string

Error title.

Unauthorized.

message

string

required

Error description.

Authentication failed or credentials were not provided. Please ensure that you have provided valid API credentials and that they are authorized to access the MassPay API.

code

integer

required

Error code.

401

Headers

object

Access-Control-Allow-Origin

string

Response body

object

title

string

Error title.

Forbidden.

message

string

required

Error description.

The requested action is not allowed or the API credentials do not have sufficient permissions. Please ensure that the API credentials used for the request have the necessary permissions to perform the requested action.

code

integer

required

Error code.

403

Headers

object

Access-Control-Allow-Origin

string

Response body

object

title

string

Error title.

Not found.

message

string

required

Error description.

The requested resource was not found. Please ensure that the URL for the request is correct and that the requested resource exists.

code

integer

required

Error code.

404

Headers

object

Access-Control-Allow-Origin

string

Response body

object

title

string

Error title.

Method not allowed.

message

string

required

Error description.

The HTTP method used for the request is not supported by the MassPay API. Please ensure that you are using the correct HTTP method (e.g., POST) for the specific MassPay API endpoint.

code

integer

required

Error code.

405

Headers

object

Access-Control-Allow-Origin

string

Response body

object

title

string

Error title.

Internal server error.

message

string

required

Error description.

An unexpected error occurred on the server-side while processing the request. Please try again later or contact support if the issue persists.

code

integer

required

Error code.

500

Headers

object

Access-Control-Allow-Origin

string

Response body

object

title

string

Error title.

Gateway Time-out.

message

string

required

Error description.

The request timed out while waiting for a response from the server. Please try again later or contact support if the issue persists.

code

integer

required

Error code.

500

Headers

object

Access-Control-Allow-Origin

string

Updated about 1 month ago

Get all stored user attributes

Get user attributes for destination_token

Did this page help you?

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.masspay.io/v1.0.0/payout/attribute/user_token/destination_token/currency \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
 
1
{
2
  "attr_set_token": "attr_set_87e7599d-af96-4aec-9097-c2a105bc2d64"
3
}

Updated about 1 month ago

Get all stored user attributes

Get user attributes for destination_token

Did this page help you?

Headers

Response

Access-Control-Allow-Origin

Introduction to MassPay REST API
Overview
Authentication
Idempotent Requests
Versioning
Webhooks
Swimlanes
Error codes
Data Migration
Testing

MassPay API
Account
Get top up transaction detailsget
List account topup funding instrumentsget
Add new funding instrumentpost
Top up account balancepost
Get certified account statementget
Update webhook URLput
Get account configurationget
Get current available balanceget
Attribute
Get user attributes for destination_tokenget
Store user attributespost
Get all stored user attributesget
Card
Update MassPay card informationput
Get MassPay card informationget
Catalog
Get available user agreementsoptns
Get user agreementget
Returns provided serviceget
Returns list of alternative service to a provided serviceget
Gets a list of Companies and their service offerings for the given country code.get
Gets a list of Companies and their best service offerings for the given country code.get
Gets a list of countries where services offered.get
KYC
Link a Veriff session idput
Get a Veriff session linkget
Get all KYC sessionsget
Upload ID photospost
Attributes velocity checkpost
Load
Reverse a user loaddelete
Resend load notificationput
Get history of loads by user tokenget
Initiate a load transactionpost
Resend balance notificationput
Payout
Get transaction confirmation detailspatch
Get status of a payout by payout tokenget
Commit payout transactionput
Get history of payouts by user tokenget
Initiate a payout transactionpost
Spend Back
Initiate a spend back transactionpost
Get history of spend backs by user tokenget
Tax
Get all tax interview sessionsget
Get link for tax interviewget
Get list of users' annual balanceget
User
All Users' Transactions historyget
Transactions historyget
Lookup an existing userget
Updated userput
Get user by user tokenget
Create a userpost
Wallet
Delete AutoPayout ruledelete
Add AutoPayout rulepost
Get all AutoPayout rulesget
Retrieve all available wallets for a userget
Business
Update businesspatch
Create a businesspost

Introduction to MassPay REST API
Overview
Authentication
Idempotent Requests
Versioning
Webhooks
Swimlanes
Error codes
Data Migration
Testing

MassPay API
Account
Get top up transaction detailsget
List account topup funding instrumentsget
Add new funding instrumentpost
Top up account balancepost
Get certified account statementget
Update webhook URLput
Get account configurationget
Get current available balanceget
Attribute
Get user attributes for destination_tokenget
Store user attributespost
Get all stored user attributesget
Card
Update MassPay card informationput
Get MassPay card informationget
Catalog
Get available user agreementsoptns
Get user agreementget
Returns provided serviceget
Returns list of alternative service to a provided serviceget
Gets a list of Companies and their service offerings for the given country code.get
Gets a list of Companies and their best service offerings for the given country code.get
Gets a list of countries where services offered.get
KYC
Link a Veriff session idput
Get a Veriff session linkget
Get all KYC sessionsget
Upload ID photospost
Attributes velocity checkpost
Load
Reverse a user loaddelete
Resend load notificationput
Get history of loads by user tokenget
Initiate a load transactionpost
Resend balance notificationput
Payout
Get transaction confirmation detailspatch
Get status of a payout by payout tokenget
Commit payout transactionput
Get history of payouts by user tokenget
Initiate a payout transactionpost
Spend Back
Initiate a spend back transactionpost
Get history of spend backs by user tokenget
Tax
Get all tax interview sessionsget
Get link for tax interviewget
Get list of users' annual balanceget
User
All Users' Transactions historyget
Transactions historyget
Lookup an existing userget
Updated userput
Get user by user tokenget
Create a userpost
Wallet
Delete AutoPayout ruledelete
Add AutoPayout rulepost
Get all AutoPayout rulesget
Retrieve all available wallets for a userget
Business
Update businesspatch
Create a businesspost

201Succesfully created.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method Not Allowed.

500Internal server error.

504Gateway Time-out.