POST
/
v1
/
service
/
payment
/
expected
curl --request POST \
  --url https://api.nxos.io/v1/service/payment/expected \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "<string>",
  "asset_code": "<string>",
  "source_account_id": "<string>",
  "destinations": [
    {
      "amount": "<string>",
      "asset_code": "<string>",
      "destination_account_id": "<string>",
      "metadata": {},
      "type": "<string>"
    }
  ],
  "payment_reference": "<string>",
  "network": "<string>",
  "metadata": {}
}'
{
  "payment_id": "<string>",
  "amount": "<string>",
  "asset_code": "<string>",
  "source_account_id": "<string>",
  "payment_destinations": [
    {
      "amount": "<string>",
      "asset_code": "<string>",
      "destination_account_id": "<string>",
      "metadata": {},
      "type": "<string>"
    }
  ],
  "external_tracking_id": "<string>",
  "payment_reference": "<string>",
  "status": "EXEPCTED"
}

Body

application/json
​
amount
string
required

The amount of the payment, in string representation. All amounts should be passed in full subunits, e.g. 1000 for 10.00

​
asset_code
string
required

The asset_code of the payment. The asset must've been created in the system before it can be used in payments

​
source_account_id
string
required

The source account ID of the expected payment

​
destinations
object[]
required
​
payment_reference
string
required

The payment reference used by the sender to reconcile the payment

​
network
string
required

The network of the payment, such as SEPA, or Providers such as Wise

​
metadata
object
required

Additional metadata for the payment. This can be any key-value pair that is relevant to the payment. For example, a payment can have a metadata key of "invoice_id" with a value of "1234" to map it internally to an invoice

Response

200 - application/json
The request has succeeded.
​
payment_id
string
required

The unique ID of the payment

​
amount
string
required

The amount of the payment, in string representation. All amounts should be passed in full subunits, e.g. 1000 for 10.00

​
asset_code
string
required

The asset_code of the payment. The asset must've been created in the system before it can be used in payments

​
source_account_id
string
required

The source account ID of the payment

​
payment_destinations
object[]
required

The destinations for a payment, such as recipients or revenue accounts

​
status
enum<string>
required

The current status of the payment

Available options:
EXEPCTED,
SETTLED
​
external_tracking_id
string

The unique ID of the payment in the external system. This ID will guarantee the idempotency of the operation

​
payment_reference
string

The transfer reference used by the sender to reconcile the payment. Typically, this is a reference code that is included by the the sender in bank-transfers