Get purpose codes

Purpose codes accepted for a payout from this Sender to a bank Beneficiary. Every order needs a purpose_code that is valid for its Sender and Beneficiary. Always fetch the list and use the code exactly as returned; do not hard-code it. Names are returned in Chinese.

OTHR (“other”) requires an extra description that orders can’t carry yet. Don’t offer it.

GET /api/v2/payouts/senders/{id}/purposes

Get purpose codes

cURL

curl --request GET \
  --url https://api.mansa.xyz/api/v2/payouts/senders/{id}/purposes \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'

200

[
  {
    "code": "006-01",
    "name": "同名划转"
  },
  {
    "code": "006-26",
    "name": "货款"
  },
  {
    "code": "006-27",
    "name": "物流费用"
  }
]

Authorizations

x-api-key · string · header · required

API key for authentication

Authorization · string · header · required

ES256 JWT signed by the private key registered to the API key above. Claims: sub (=API key), uri, nbf, iat, exp, and bodyHash (HMAC-SHA512 of uri + rawBody + nbf using a shared secret, base64).

Path Parameters

id · string<uuid> · required

ID of the Sender

Query Parameters

beneficiaryId · string<uuid> · required

ID of the Beneficiary. This one query parameter is camelCase.

Response

200

application/json

Accepted purpose codes

code · string · required

Use exactly as returned.

Example:

"006-26"

name · string · required

Returned in Chinese.

Example:

"货款"