PApaycrest
General

Verify account

Changed on

Resolves the account holder name when available. For some fiat corridors (e.g. KES M-Pesa), data may be "OK" when the account is valid but no display name is returned — supply your own accountName on the order in that case.

post/verify-account

Request

  • Base URL
    https://api.paycrest.io/v2
  • URL
    https://api.paycrest.io/v2/verify-account
  • Auth
    none declared

Request body

institutionstring required

Institution code (SWIFT code or custom PayCrest code ending with 'PC'). See Code Standards for details.

accountIdentifierstring required

Bank account number, mobile wallet MSISDN, Till/Paybill identifier, or other account identifier.

For mobile_money institutions, the API normalizes phone numbers before verification: strips +, removes a leading domestic 0, and adds the country dial code when missing (KES 254, UGX 256, TZS 255, GHS 233). Examples for KES M-Pesa — 0712345678, +254712345678, and 254712345678 all normalize to 254712345678.

KES Till/Paybill identifiers are not normalized when metadata indicates Till/Paybill, or when the value looks like Paybill (business|reference) or Till (fewer than 9 digits).

metadataobject

Optional. Used for KES Till/Paybill verify so phone normalization is not applied. Same semantics as recipient metadata on order create (e.g. channel Till or Paybill, businessNumber).

Response

Account verified

statusstring
messagestring
datastring

Resolved account name, or "OK" when valid but name lookup is unavailable

Example response

{
  "status": "success",
  "message": "Account name was fetched successfully",
  "data": "JOHN DOE"
}

Changes

  • b2558cacb755Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      removed the non-success response with the status