Create a new stablecoin inbound payment beta

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

SecurityCommonAuth
Request
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
Request Body schema: application/json

Body

budgetId
required
string <uuid> <= 36 characters

The ID of the budget to work with.

remitterId
required
string <uuid>

The ID of the BVNK remitter associated with the payment.

amount
required
number >= 10

The amount to be paid.

displayName
string or null [ 1 .. 255 ] characters
sourceCurrencyCode
required
string [ 3 .. 4 ] characters

The currency the remitter will send.

destinationCurrencyCode
required
string [ 3 .. 4 ] characters

The currency that should be received into the budget.

returnUrl
string or null <uri>

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

requesterIpAddress
string

The IP address of the payment requester.

expiryMinutes
integer [ 1 .. 1000000 ]

The number of minutes after which the payment should expire.

Responses
201

Created

post/stablecoins/payments
Request samples
application/json
{
  • "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 samples
application/json
{
  • "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": {},
  • "expiresAt": "2025-01-30T08:30:00.000Z",
  • "createdBy": "John Smith",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}