Update a beneficiary status

POST

/api/merchant-portal/merchant-access/whitelist-account/update-whitelist-status

This API allows you to update the status of a beneficiary, toggling between active and inactive status.

When to use this API?

To prevent a whitelisted beneficiary from receiving future funds or from being used in payout instructions.

To resume a previously disabled beneficiary so they can start receiving funds again or be used in payout instructions.

Request

Header Params

Content-Type

string

required

Example:

application/json

Body Params application/json

request_time

string

required

Request date and time in UTC format as YYYYMMDDHHmmss.

merchant_id

string

required

A unique merchant key which provided by ABA Bank.

<= 20 characters

merchant_auth

string

required

The JSON-encoded object containing mc_id, payee, and status is encrypted using RSA public key encryption in chunks. The resulting encrypted data is then concatenated and encoded in Base64 format.

mc_id string mandatory
A unique merchant key which provided by ABA Bank. Same value as merchant_id

payee string mandatory
Beneficiary identifier: It can be either a MID or an ABA account.

status int mandatory
To disable the beneficiary, set the value to 0. To activate the beneficiary, set the value to 1.

PHP Sample Code

hash

string

required

Base64 encode of hash hmac sha512 encryption of concatenates values request_time and merchant_auth with public_key.

Here is an example code in PHP

Example

{
  "request_time": "20200728093403",
  "merchant_id": "ec000002",
  "merchant_auth": "39aaa43.....0c00a",
  "hash": "EVDFA2118UD0boKhkAcOb...+5KCCt+sWw=="
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/merchant-portal/merchant-access/whitelist-account/update-whitelist-status' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request_time": "20200728093403",
    "merchant_id": "ec000002",
    "merchant_auth": "39aaa43.....0c00a",
    "hash": "EVDFA2118UD0boKhkAcOb...+5KCCt+sWw=="
}'

Responses

🟢200OK

application/json

Body

data

object

optional

name

string

optional

The name of the beneficiary: if the type is MID, it will be the outlet name; if it is an account, it will be the account holder's name

payee

string

optional

This value represent the destination beneficiary it can be MID or ABA Account number

<= 250 characters

currency

string

optional

If payee is MID, the value here will be merchant's currency and if the payee is an ABA Account holder it will return account currency.

type

string

optional

If payee is MID, the value here is "Merchant" if the payee is an ABA Account holder it will return "ABA Account"

<= 20 characters

status

string

optional

The current status of the beneficiary.

1 : Active

0 : Inactive

created_at

string

optional

Date and time that the beneficiary was created or added to the list.

status

object

optional

code

string

optional

00 : Success!

PTL02 : Wrong hash

PTL04 : Parameter validation required

PTL46 : Merchant not found

PTL149 : Invalid whitelist account

PTL150 : Business profile is not found

message

string

optional

See the property code above.

Examples

SuccessException

{
  "data": {
    "name": "INDOCHINE LODGE",
    "payee": "318111358120004",
    "currency": "USD",
    "type": "MID",
    "status": "1",
    "created_at": "2022-09-19 07:52:51"
  },
  "status": {
    "code": "00",
    "message": "Success!"
  }
}

Payout

Add a beneficiary to whitelist