Account

Top up account balance

This POST endpoint is used to initiate a topup from the funding instrument to your MassPay account balance. <br> You can use this endpoint to start the topup process. <br> The body of the request requires the token of the funding instrument, the type of rail you would like to use, the amount to topup and the currency. <br> The response will include a JSON objects containing a success boolean.

post/payout/account/topup

Request

Base URL
https://api.masspay.io/v1.0.0
Auth
- API key in header Authorization
- or API key in header x-api-key
TypeScript
https://skmtc.dev/masspay/apis/masspay-api/docs/payout/account/topup/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

funding_instrument_tokenstring required

Token of funding instrument

type'ACH' | 'AFT' required

Type of transaction

currency_codestring required

3 letter currency code to top up

amountnumber required

Amount to top up

Example request

{
  "funding_instrument_token": "fund_be2f0ab9-a503-473e-aa33-0af196e54647",
  "type": "ACH",
  "currency_code": "USD",
  "amount": 10000
}

Response

successful operation

topup_tokenstring uuid required

Topup token representing the topup transaction

Changes

No recorded changes to this operation across all 2 revisions of this API.