Create payout order (v2)

post

https://sandbox-api-v2.dogpay.com/open-api/v2/payout/create

Optional partyFields save → channel pre-check → payout creation. When party fields are incomplete, returns status=PARTY_FIELDS_REQUIRED with fields only. Person accounts must provide sourceOfFunds and sourceOfFundsMaterial; business accounts may optionally include them. Debit balance: va_group (fiat) or cw (crypto); paymentCurrency must match balance currency (use PayerCurrencyEnumV2 for BTC/USDT etc.). costBorne: unsupported channels (e.g. va_005/007/015) persist null; va_008_01/va_012_01+SWIFT SHA/OUR (omit → SHA; OUR charges ourFee); OptionalOur non-SWIFT forced SHA. channelCode: OpenApiPayoutChannelCodeEnum (va_005_01/007_01/008_01/012_01/015_01→internal va_*); va_012/va_015 typically offline per payout_channel_route.execution_mode (same corridor as Web). callId is consumed only on successful creation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

callId

string

required

API Caller ID (unique within the same business; consumed only when payout is created)

payeeId

string

required

Payee ID

receiveType

string

enum

required

Payee Receivable Type

Allowed:

channelCode

string

enum

required

Payout product code (OpenAPI). *_01 maps 1:1 to internal channel (va_005_01→va_005, va_007_01→va_007, va_008_01→va_008, va_012_01→va_012, va_015_01→va_015); suffix reserved for future sub-products. Corridor matches Web payout_channel_route; va_012/va_015 are typically offline (ops payout) per route execution_mode.

Allowed:

balanceId

string

required

Debit balance ID (va_group or cw; ca not supported)

costBorne

string

enum

Cost borne. Unsupported channels (e.g. va_005/007/015 inherent OUR) persist null. va_008_01 / va_012_01 + SWIFT: SHA or OUR (OUR charges ourFee); omit → SHA (same as Web, no ourFee). OptionalOur channels non-SWIFT: forced SHA.

Allowed:

paymentAmount

number

Payment amount (fixed payment amount mode). Exactly one of paymentAmount / payeeAmount is required.

payeeAmount

number

Payee amount (fixed payee amount mode). Exactly one of paymentAmount / payeeAmount is required.

paymentCurrency

string

enum

required

Payment currency (fiat or crypto when debiting cw balance)

payeeCurrency

string

enum

required

Payee currency

partyFields

object

Party field values to save before pre-check; keys match fields[].key from PARTY_FIELDS_REQUIRED response

reason

string

Note

purpose

string

enum

required

👉 Payment Purpose Codes Guide

paymentMaterial

array of strings

required

Payment proof material file ID array

paymentMaterial*

sourceOfFunds

string

enum

Source of funds (required for Person accounts; optional for business accounts). Values 1~5 same as App form source_of_funds.

Allowed:

sourceOfFundsMaterial

array of strings

Source of funds proof file IDs (required for Person accounts; optional for business accounts; upload with OpenAPI file use type SOURCE_OF_FUNDS). Stored in raw.sourceOfFundsAttachment, separate from paymentMaterial.

sourceOfFundsMaterial

Headers

dgp-entity-id

string

required

Response

Language

Credentials

Bearer

Loading…

Response

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

application/json

200