Webhooks

There is support for initiating a webhook to an https URL every time there is a status update to one of the payout transactions. In order to enable this feature, please provide a webhook URL to your account representative or set it in your client dashboard.

Signature: The webhook will include an HMAC SHA 512 value which is passed in the X-MassPay-Signature header. The header would have the following format: "t=TIMESTAMP,s=HMAC_VALUE". The HMAC_VALUE would be the HMAC computation of the TIMESTAMP|payload from the POST request. The secret for the webhook signature can be obtained through the API section in the client dashboard.

The URL will receive a POST request with the following payload format for every status change for a transaction:

{
  "payout_token": "payout_ba4275f2-bae1-488d-9d6f-20af1cd83574",
  "client_transfer_id": "aEjn345",
  "source_currency_code": "USD",
  "destination_currency_code": "MXN",
  "country_code": "MEX",
  "payer_name": "Bank Deposit",
  "source_token": "clnt_wlt_ba4275f2-bae1-488d-9d6f-20af1cd83574",
  "destination_token": "dst_d2138fd0-00be-45a8-985f-4f5bde500962",
  "destination_amount": 100.5,
  "source_amount": 100.5,
  "attr_set_token": "attr_set_b1a867c1-6e36-4525-b6d5-a20bac80e3b0",
  "exchange_rate": 18.55,
  "fee": 2.99,
  "expiration": "2019-10-30T05:40:58.475Z",
  "status": "PENDING",
  "status_reason": "Beneficiary information is incorrect",
  "event_type": "payout"
}
{
  "user_token": "usr_c06de89a-b6cb-4c75-8707-10ba8c5b69e4",
  "pdf_base64": "H4sAAAA",
  "event_type": "tax_wh_interview"
}
{
  "time_of_request": "2025-10-15 14:32:17",
  "link": "https://l.maspay.io/veriff",
  "event_type": "id_requested",
  "user_token": "usr_685a6135-b7c0-44aa-9e10-dc403acb2cc8"
}
{
  "file_upload_token": "file_req_501199fc-b914-4a45-b5d4-6273ec62b31f",
  "files_types_accepted": [
    "Bank Statement",
    "Physical Check"
  ],
  "time_of_request": "2025-10-15 14:32:17",
  "is_required": true,
  "link": "https://l.maspay.io/abc123",
  "event_type": "file_upload_req_created",
  "ref_attributes": {
    "BankAccountNumber": "**********6789",
    "Routing Number": "**********4321"
  },
  "note": "Please include all pages of the bank statement",
  "user_token": "usr_685a6135-b7c0-44aa-9e10-dc403acb2cc8"
}
{
  "file_upload_token": "file_req_501199fc-b914-4a45-b5d4-6273ec62b31f",
  "files_types_accepted": [
    "Government issued ID"
  ],
  "time_of_request": "2025-10-15 15:32:17",
  "is_required": false,
  "ref_attributes": {
    
  },
  "event_type": "file_upload_req_uploaded",
  "user_token": "usr_685a6135-b7c0-44aa-9e10-dc403acb2cc8"
}
{
  "file_upload_token": "file_req_501199fc-b914-4a45-b5d4-6273ec62b31f",
  "files_types_accepted": [
    "Bank Statement"
  ],
  "time_of_request": "2025-10-15 16:32:17",
  "is_required": true,
  "ref_attributes": {
    
  },
  "event_type": "file_upload_req_verified",
  "user_token": "usr_685a6135-b7c0-44aa-9e10-dc403acb2cc8"
}
{
    "user_token": "usr_da518958-1413-11f0-9de5-06cab49e9a05",
    "name": "MICKEY MOUSE",
    "tin_type": "SSN",
    "tin": "XXX-XX-0657",
    "status": "SUCCESS",
    "event_type": "tax_tin_matching"
}
{
  "load_token": "ld_ba4275f2-bae1-488d-9d6f-20af1cd83574",
  "time_of_load": "2019-10-24T22:54:54.793Z",
  "client_load_id": "aEjn345",
  "source_token": "usr_wlt_ba4275f2-bae1-488d-9d6f-20af1cd83574",
  "wallet_token": "usr_wlt_ba4275f2-bae1-488d-9d6f-20af1cd83574",
  "amount": 100.5,
  "source_currency_code": "USD",
  "notes": "Commission payment for July",
  "status": "COMPLETED",
  "event_type": "load"
}
{
  "load_token": "ld_ba4275f2-bae1-488d-9d6f-20af1cd83574",
  "time_of_reversal": "2019-10-24T22:54:54.793Z",
  "user_token": "usr_123e4567-e89b-12d3-a456-426614174000",
  "event_type": "load_reversal"
}
{
  "spendback_token": "123e4567-e89b-12d3-a456-426614174000",
  "client_spendback_id": "aEjn345",
  "status": "success",
  "event_type": "spendback",
  "metadata":{"property":"value"},
  "user_token":"usr_6bee1675-5201-4b19-a44b-5c76b7e70a26",
  "amount":100.5
}
{
  "user_token": "usr_123e4567-e89b-12d3-a456-426614174000",
  "new_status": "LOCKED",
  "previous_status": "ACTIVE",
  "event_type": "user_status_update"
}
{
    "status": "success",
    "verification": {
        "id": "d73bf06a-1c5b-499c-ab54-5ad680a64543",
        "code": 9121,
        "person": {
            "gender": "M",
            "lastName": "MOUSE",
            "addresses": [
                {
                    "fullAddress": "1600 PENNSYLVANIA AVENUE NW, WASHINGTON, DC 20500 UNITED STATES",
                    "parsedAddress": {
                        "city": "WASHINGTON",
                        "street": "PENNSYLVANIA AVENUE",
                        "country": "UNITED STATES",
                        "postcode": "20500",
                        "houseNumber": "1600"
                    }
                }
            ],
            "firstName": "MICKEY",
            "dateOfBirth": "2007-03-09",
            "nationality": "US"
        },
        "reason": "Attempted deceit, device screen used",
        "status": "review",
        "comments": [],
        "document": {
            "type": "ID_CARD",
            "number": "123456DISNEY",
            "country": "US",
            "validFrom": "2021-12-22",
            "validUntil": "2031-12-21"
        },
        "reasonCode": 504,
        "vendorData": "usr_123e4567-e89b-12d3-a456-426614174000",
        "decisionTime": "2024-03-28T22:12:26.339342Z",
        "acceptanceTime": "2024-03-28T22:11:30.149961Z",
        "additionalVerifiedData": {}
    },
    "technicalData": {
        "ip": "192.168.1.1"
    },
    "event_type": "veriff"
}
{
  "account_number": "12345678",
  "routing_number": "012345678",
  "institution": "CRB",
  "topup_token": "topup_68f4fdfb-6586-441a-8cbb-9f9e352c0b1e",
  "funding_token": "fund_9767edf2-04e4-4a4a-9d8c-afe5fa5f2ba8",
  "title": "Company ABC",
  "event_type": "new_deposit_account"
}
{
  "amount": 15.1,
  "currency": "USD",
  "source": "Wells Fargo",
  "event_type": "balance_credit"
}
{
  "payout_reversal_token": "payout_rev_00900dc5-de31-4d37-8ba2-6f7460b19fb0",
  "source_amount": 100.5,
  "source_currency_code": "USD",
  "exchange_rate": 1,
  "destination_amount": 100.5,
  "destination_currency_code": "USD",
  "status": "PROCESSING",
  "payout_token": "payout_ea4b5932-91f0-4b91-9590-b27f6d666dcd",
  "metadata": {
    "key": "value"
  },
  "fee": 1.5,
  "client_transfer_id": "Reversal54543",
  "original_destination_amount": 100.5,
  "total_reversed_amount": 10.2,
  "event_type": "payout_reversal_created"
}