Mansa Docs

List Beneficiaries

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

import requests

url = "https://api.mansa.xyz/api/v2/payouts/beneficiaries"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://api.mansa.xyz/api/v2/payouts/beneficiaries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sender_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "beneficiary_type": "bank",
    "account_holder_name": "<string>",
    "account_number": "<string>",
    "status": "pending",
    "active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "bank_name": "<string>",
    "bank_swift": "<string>",
    "bank_country_code": "<string>",
    "bank_address": "<string>",
    "bank_province": "<string>",
    "bank_city": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "chain_type": "TRC20",
    "remark": "<string>",
    "status_reason": "<string>"
  }
]

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 429,
  "message": "Too many requests"
}

{
  "statusCode": 500,
  "message": "Internal server error"
}

GET

/

api

/

v2

/

payouts

/

beneficiaries

List Beneficiaries

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

import requests

url = "https://api.mansa.xyz/api/v2/payouts/beneficiaries"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://api.mansa.xyz/api/v2/payouts/beneficiaries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sender_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "beneficiary_type": "bank",
    "account_holder_name": "<string>",
    "account_number": "<string>",
    "status": "pending",
    "active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "bank_name": "<string>",
    "bank_swift": "<string>",
    "bank_country_code": "<string>",
    "bank_address": "<string>",
    "bank_province": "<string>",
    "bank_city": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "chain_type": "TRC20",
    "remark": "<string>",
    "status_reason": "<string>"
  }
]

{
  "statusCode": 401,
  "message": "Unauthorized"
}

{
  "statusCode": 429,
  "message": "Too many requests"
}

{
  "statusCode": 500,
  "message": "Internal server error"
}

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).

Response

List of Beneficiaries

id

string<uuid>

required

sender_profile_id

string<uuid>

required

The Sender link is permanent.

beneficiary_type

enum<string>

required

Available options:

bank,

crypto,

platform

account_holder_name

string

required

account_number

string

required

status

enum<string>

required

Starts pending. No client action moves it — resolves automatically once asynchronous partner KYC/KYB review completes.

Available options:

pending,

ready,

rejected

active

boolean

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

bank_name

string | null

Bank only

bank_swift

string | null

Bank only

bank_country_code

string | null

Bank only

bank_address

string | null

Bank only

bank_province

string | null

Bank only

bank_city

string | null

Bank only

first_name

string | null

last_name

string | null

chain_type

enum<string> | null

Crypto only

Available options:

TRC20,

ERC20,

null

remark

string | null

status_reason

string | null

Present only when status is rejected.