WePay logo
      Nothing Found

Create a payout method

post/payout_methods

The POST /payout_methods call allows your platform to create a new payout method owned by a legal entity. Payout methods represent payout targets, such as bank accounts.

SecurityappIdAuth and appTokenAuth
Request
header Parameters
Api-Version
required
string
Example: 3.0
Content-Type
required
stringapplication/json
Example: application/json
Unique-Key
string
WePay-Risk-Token
string

This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used.

Client-IP
string

This header is required when tokenizing Payment Methods, Legal Entities, and Payout Methods when the tokenization JS library is not being used.

Request Body schema: application/json
legal_entity_id
required
string [ 1 .. 255 ] characters

ID of the object or resource.

nickname
required
string [ 1 .. 64 ] characters
type
required
string

Possible values: payout_bank_ca, payout_bank_us and payout_bank_gb. Note: The paper_check option requires permission from WePay to use. Reach out to your integration team for assistance.

Enum: Description
payout_bank_ca

Bank account in Canada.

payout_bank_gb

Bank account in the UK (not currently supported).

… 3 more
object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

object

Define how to payout a merchant based in the US via paper check. Note: Paper checks require permission from WePay, and only US-based merchants can receive payouts via paper check. Reach out to your integration team for further information.

object
object
object
Array of objects or null

Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects.

object

A previously created token. Note: Using tokens to pass highly-sensitive data directly to WePay may help your platform avoid certain compliance and regulatory overhead. Learn more about tokens here.

Responses
201
Response Schema: application/json
resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
payout_methods
id
required
string

The ID of the payout method, generated by WePay when the payout method is created.

path
required
string

The path of resource and resource ID.

api_version
string
create_time
integer <int64> >= 0

The time (in UNIX) when the payout method was created.

object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

nickname
string [ 1 .. 64 ] characters

The nickname of the payout method.

object

Details the owner resource and owner path.

object

Define how to payout a merchant based in the US via paper check. Note: Paper checks require permission from WePay, and only US-based merchants can receive payouts via paper check. Reach out to your integration team for further information.

object

Contains parameters relevant to the payout method.

object

Contains parameters relevant to the payout method.

object

Contains parameters relevant to the payout method.

status
string

Describes the status of the payout method. Possible values include: active, verified, unverified, pending_verification, disabled, and deleted

Enum: Description
active

This payout method is active, so it can be queried via the APIs and used as a merchant's payout method.

disabled

Due to three (3) failed attempts to send payouts to this payout method, it has been disabled. Find more information on the failed payouts by examining the failure_reason object of the payout resource. Note that disabled payout methods cannot be queried via the APIs or used as a merchant's payout method.

… 4 more
type
string

Possible values: payout_bank_ca, payout_bank_us and payout_bank_gb. Note: The paper_check option requires permission from WePay to use. Reach out to your integration team for assistance.

Enum: Description
payout_bank_ca

Bank account in Canada.

payout_bank_gb

Bank account in the UK (not currently supported).

… 2 more
400

INVALID_PARAMS, MERCHANT_ACCOUNT_CANNOT_ACCEPT_PAYMENTS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "custom_data": {
    • "my_key": "invoice #54321"
    },
  • "legal_entity_id": "42d2c2f1-5aeb-4929-944f-e220b4c9425b",
  • "nickname": "bofa checking 6789",
  • "payout_bank_us": {
    • "account_number": "123456789",
    • "account_type": "checking",
    • "routing_number": "987654321"
    },
  • "type": "payout_bank_us"
}
Response samples
application/json
{
  • "create_time": 1480700534,
  • "custom_data": null,
  • "id": "0102b1c6-2bc7-448a-aa1d-076b1637547c",
  • "nickname": "Foo Bar Bank",
  • "owner": {
    • "id": "3cd20b3c-4008-400b-b708-2b844ce7be84",
    • "path": "/legal_entities/3cd20b3c-4008-400b-b708-2b844ce7be84",
    • "resource": "legal_entities"
    },
  • "path": "/payout_methods/0102b1c6-2bc7-448a-aa1d-076b1637547c",
  • "payout_bank_us": {
    • "account_type": "checking",
    • "last_four": "4739"
    },
  • "resource": "payout_methods",
  • "status": "active",
  • "type": "payout_bank_us",
  • "api_version": "3.0"
}