Create Prepaid Account

Creates a Prepaid account for a Recipient.

201 - Created, will include a Location response header
200 - Request Succeeded, but entity not created
400 - Bad Request, missing or invalid parameters
404 - Recipient ID not found
422 - Account exists or locked due identity verification failure

👍

Create Prepaid Account - Success Path

  1. Create Prepaid Account API
  2. Initial response value for prepaid_account_status will be PROCESSING
  3. Prepaid account will go through verification and creation with partner bank
  4. Webhook will indicate the prepaid_account_status is PENDING_ACTIVATION
  5. Account GET will return relevant account details
🚧

Create Prepaid Account - Error Path

  1. Create Prepaid Account API
  2. Initial response value for prepaid_account_status will be PROCESSING
  3. Prepaid account will go through verification with partner bank
  4. Webhook will indicate the prepaid_account_status is NOT_CREATED and will include a prepaid_account_error field containing the verification reason.
  5. Create Prepaid Account API can be called again with updated information in attempt to create the Prepaid account.
📘

API Webhooks

A webhook Webhooks will be posted if your API account is configured for Payment Account Webhooks upon success or failure of Prepaid account creation. Webhooks are typically sent within 1 minute of the Create Account API call.

Path Params
string
required

Payer ID

string
required

Recipient ID

Body Params
string

Account first name

string

Account last name

date

Date of birth

string

TIN - 9 digits, no spaces or dashes

address
object
Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json