Sign in

v1

latestOpenAPI 3.1.0UNLICENSED2026-07-2613101.1 MB
Payments

Create a new stablecoin inbound payment

Creates a new stablecoin inbound payment for a given remitter. The exchange rate isn't locked in until the payment is accepted.

post/stablecoins/payments

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091

Request body

budgetIdstring uuid required

The ID of the budget to work with.

remitterIdstring uuid required

The ID of the BVNK remitter associated with the payment.

amountnumber required

The amount to be paid.

displayNamestring nullable
sourceCurrencyCodestring required

The currency the remitter will send.

destinationCurrencyCodestring required

The currency that should be received into the budget.

returnUrlstring uri nullable

The URL that the customer will be redirected to if they click the Back button on the link url page. Must start with https://

requesterIpAddressstring

The IP address of the payment requester.

expiryMinutesinteger

The number of minutes after which the payment should expire.

Example request

{
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "remitterId": "a1111111-2222-3333-4444-555555555555",
  "amount": 100,
  "displayName": "Invoice #12345",
  "sourceCurrencyCode": "USDC",
  "destinationCurrencyCode": "USD",
  "returnUrl": "https://www.example.com/receive-money",
  "requesterIpAddress": "127.0.0.1",
  "expiryMinutes": 15
}

Response

Created

idstring uuid required

The ID of the BVNK payment to work with.

accountIdstring required

The ID of the account to work with.

budgetIdstring uuid required

The ID of the budget to work with.

status'PENDING' | 'PROCESSING' | 'CANCELLED' | 'COMPLETE' | 'UNDERPAID' | 'OVERPAID' | 'EXPIRED' required
remitterIdstring uuid required

The ID of the BVNK remitter associated with the payment.

amountnumber required

The amount to be paid.

displayNamestring nullable
sourceCurrencyCodestring required

The currency the remitter will send.

destinationCurrencyCodestring required

The currency that should be received into the budget.

returnUrlstring uri nullable

The URL that the customer will be redirected to if they click the Back button on the link url page. Must start with https://

expiresAtstring date-time

The date/time at which the payment expires. ISO 8601 format without milliseconds.

createdBystring required
createdAtstring date-time required

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAtstring date-time required

The date the Resource was last modified. ISO 8601 format without milliseconds.

Example response

{
  "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "accountId": "F50091",
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "status": "PENDING",
  "remitterId": "a1111111-2222-3333-4444-555555555555",
  "amount": 100,
  "displayName": "Invoice #12345",
  "sourceCurrencyCode": "USDC",
  "destinationCurrencyCode": "USD",
  "returnUrl": "https://www.example.com/receive-money",
  "link": {
    "url": "https://pay.sandbox.bvnk.com/channel?uuid=9d1f67f2-a647-404b-9b02-247c77be81d0",
    "chains": [
      {
        "protocol": "ETH",
        "address": "0x0000000000000000000000000000000000000000"
      }
    ]
  },
  "expiresAt": "2025-01-30T08:30:00.000Z",
  "createdBy": "John Smith",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}