Subscribe to transaction events
POST/api/v1/transactions/subscribe
Subscribe to updates across all transactions
Request
- application/json
Body
required
Responses
- 201
- 400
- 401
- 403
- 404
- 405
- 415
- 429
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
Wallet ID of the transaction
Unique ID of the transaction
Short ID of the transaction
External ID of the transaction
Possible values: [PAYMENT
, DEPOSIT
, CHARGE
, EXCHANGE
, OTHER_CREDIT_DEBIT
]
Type of the transaction
status objectrequired
Status of the transaction
Possible values: [FUNDS_REQUIRED
, PENDING
, AWAITING_APPROVAL
, PROCESSING
, SUCCESS
, FAILED
, REVERSED
]
State of the transaction
Reason for the transaction state
Completion status of the transaction
amount objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
deposit object
Details of the deposit transaction
Sender's account identifier for the deposit
Name of the sender for the deposit
Reference for the sender's deposit
payment object
Details of the payment transaction
Beneficiary's account identifier for the payment
Name of the beneficiary for the payment
Reference for the payment
exchange object
Details of the exchange transaction
rate objectrequired
Rate of the exchange
Possible values: [BID
, OFFER
]
from objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
to objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
charge object
Details of the charge transaction
Charge for the transaction ID
Creation time of the transaction
Completion time of the transaction
{
"walletId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shortId": "TR123",
"externalId": "EXT123",
"type": "DEPOSIT",
"status": "COMPLETED",
"amount": {
"amount": 100,
"currency": "USD"
},
"deposit": {
"senderAccountIdentifier": "ACC123",
"senderName": "John Doe",
"senderReference": "REF123"
},
"payment": {
"beneficiaryAccountIdentifier": "BEN123",
"beneficiaryName": "Jane Doe",
"paymentReference": "PAY123"
},
"exchange": {
"rate": {
"price": 0,
"currencyPair": "string",
"type": "BID"
},
"from": {
"amount": 100,
"currency": "USD"
},
"to": {
"amount": 100,
"currency": "USD"
}
},
"charge": {
"chargeForTransactionId": "CHG123"
},
"createdAt": "2023-01-01T00:00:00Z",
"completedAt": "2023-01-01T00:00:00Z"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Method Not Allowed
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unsupported Media Type
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Callbacks
- POST Transaction webhook
POST$request.body.callbackUrl
- application/json
Body
required
Request body to be implemented
Wallet ID of the transaction
Unique ID of the transaction
Short ID of the transaction
External ID of the transaction
Possible values: [PAYMENT
, DEPOSIT
, CHARGE
, EXCHANGE
, OTHER_CREDIT_DEBIT
]
Type of the transaction
status objectrequired
Status of the transaction
Possible values: [FUNDS_REQUIRED
, PENDING
, AWAITING_APPROVAL
, PROCESSING
, SUCCESS
, FAILED
, REVERSED
]
State of the transaction
Reason for the transaction state
Completion status of the transaction
amount objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
deposit object
Details of the deposit transaction
Sender's account identifier for the deposit
Name of the sender for the deposit
Reference for the sender's deposit
payment object
Details of the payment transaction
Beneficiary's account identifier for the payment
Name of the beneficiary for the payment
Reference for the payment
exchange object
Details of the exchange transaction
rate objectrequired
Rate of the exchange
Possible values: [BID
, OFFER
]
from objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
to objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
charge object
Details of the charge transaction
Charge for the transaction ID
Creation time of the transaction
Completion time of the transaction
Callbacks Responses
- 200
None 200 will be retried with exponential backoff upto 7 days