Settlement Awaiting Payment

wbhk

Payload

Settlement Event

uuid

required

Resource unique identifier

companyId

uuid

required

Resource unique identifier

type

string

enum

required

Type of the settlement. Can be used to differentiate standard settlements from others in the future.

Allowed:

countOrders

number

required

operation

string

enum

Type of the settlement operation. Indicates if the transaction is a BUY (e.g., BRL to USD) or a SELL (e.g., USD to BRL).

Allowed:

bankProvider

string

enum

required

Bank provider

Allowed:

currencyPair

object

required

Currency pair used to define the operationt type

operationNature

object

required

Operation nature

customerRate

number

required

Rate

effectiveRate

number

required

Rate

paymentAmount

object

required

Monetary amount without decimal precision

receiveAmount

object

required

Monetary amount without decimal precision

counterparty

object

Counterparty details

sourceBankingChannel

object

Bank Channel

targetBankingChannel

object

Bank Channel

currentState

object

required

Represents a single state transition in the settlement lifecycle.

states

array of objects

required

states*

atTime

date-time

required

UTC time (RFC3339)

Headers

X-Company-Id

uuid

Company unique identifier

X-Message-Id

string

Message unique identifier

X-Message-Signature

string

Message signature

X-Event-Type

string

Event Type

X-Resource-Name

string

Resource Name

Response

200

Return 200 status to indicate that the event was processed successfully

Loading…