Add a Payee

post

https://api-test.qualpay.com/platform/vault/payee

Creates a payee profile in the Payee Vault. Returns a payee_id, which you can use to manage the profile.

Note: The Payee Vault API resource is intended for a very specific use case and requires special permissions. Contact Qualpay Support to enable it.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Add Payee Request

payee_name

string

required

Format: Variable length, up to 64 AN
Description: Payee name.

merchant_id

integer

Format: Variable length, up to 16 N
Description: Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on behalf of another merchant.
Conditional Requirement: Required if this request is on behalf of another merchant.

payee_account

object of objects

Description: Payee account information. Possible fields: type_id, tr_number, dda_number, accountholder_name.

payee_address

array of objects

Description: Payee address.

payee_address

payee_email

array of strings

Description: An array of payee email addresses.

payee_email

payee_phone

string

Format: Variable length, up to 32 N
Description: Payee phone number. Prefix the number with + and the country code.

vendor_id

int64

Unique vendor ID assigned to the integrator.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Request Validation Failed

500Internal Error