Make a Stablecoin Payout from Your Partner Wallet

When creating a payout, there are two possible flows:

You already know the crypto address of the destination of the payout and can specify it in the API call.
You don't know the crypto address of the destination of the payout, and will redirect the user to the hosted page to collect it.

To make a stablecoin payout, send the POST /api/v1/pay/summary request with the following body parameters:

{
  "merchantId": "7a12944d-d422-4218-9ff6-a0be0a1554a6",
  "amount": 1000,
  "currency": "USD",
  "reference": "REF777579",
  "type": "OUT",
  "returnUrl": "https://my-return-url.com",
  "customerId": "1289702",
  "flow": "EMBEDDED_CRYPTO",
  "payOutDetails": {
    "currency": "USDC",
    "code": "crypto",
    "address": "0xca3b0670d63f4faa1a876efce4c471fb41abf124",
    "protocol": "ERC20"
  },
  "complianceDetails": {
    "requesterIpAddress": "77.71.188.87",
    "partyDetails": [
      {
        "type": "BENEFICIARY",
        "entityType": "INDIVIDUAL",
        "firstName": "John",
        "lastName": "Doe",
        "dateOfBirth": "1984-06-30",
        "relationshipType": "THIRD_PARTY",
        "countryCode": "DE"
      }
    ]
  },
  "embeddedCustomerDetails": {
    "reference": "a7e21c62-27b8-4b3b-b51e-eb10edeb1731"
  }
}

For the detailed description of each parameter, see the Create a payout guide. Note the specific fields required for the Embedded Model.

Parameter	Required	Description
`flow`	✔️	Indicates that payouts are done starting from your pre-funded Partner wallet, converted to crypto at BVNK, then paid out as crypto via the Embedded Partner Customer. Possible values: `EMBEDDED_CRYPTO`
`embeddedCustomerDetails`	✔️	Indicates unique custom reference to be sent in the request in the UUID format. You can use BVNK-generated `reference` that specifies the Embedded Partner Customer on behalf of which the payment should be initiated. See Retrieve Embedded Partner Customer Details on how to retrieve the reference or grab it from the Customer section in the Merchant Portal. Alternatively, specify your own unique `externalReference`

Parameter

Required

Description

flow

✔️

Indicates that payouts are done starting from your pre-funded Partner wallet, converted to crypto at BVNK, then paid out as crypto via the Embedded Partner Customer.

Possible values: EMBEDDED_CRYPTO

embeddedCustomerDetails

✔️

Indicates unique custom reference to be sent in the request in the UUID format.

You can use BVNK-generated reference that specifies the Embedded Partner Customer on behalf of which the payment should be initiated. See Retrieve Embedded Partner Customer Details on how to retrieve the reference or grab it from the Customer section in the Merchant Portal.

Alternatively, specify your own unique externalReference

Flow of Funds

The EMBEDDED_CRYPTO parameter will signal the system to follow the below flow of funds. All steps are automated and will be executed within seconds.