Create a Partner

post

https://example.com/api/v2/partners

Making a POST request to this endpoint enables you to create a partner that can be used as reference for future payment API. It is also important to register a bank account detail as well if you want to make a payout transaction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Partner name

number

string

required

Partner number or code. Value must be unique per company

type

string

enum

required

Partner type to classify partners

Allowed:

business_type

string

enum

Partner business type

Allowed:

string

Partner email address

phone

string

required

Partner phone number in E.164 international format

mobile_phone

string

Partner mobile phone number in E.164 international format

address

object

Partner address detail

notes

string

Partner Note, to help you describe and identify the partner faster

virtual_account

string

Partner's VA Account Number

contacts

array of objects

Contact person detail

contacts

bank_accounts

array of objects

Bank account information

bank_accounts

custom_type

string

Responses

Language

Credentials

Loading…

Response

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

application/json

201Successful operation

400Bad request

defaultUnsuccessful operation