Subscribe to transaction events

POST 
/api/v1/transactions/subscribe

Subscribe to updates across all transactions

Request

application/json

Body

required

callbackUrl stringrequired
sharedKey stringrequired
headerKey string
headerValue string

Responses

201

Created

application/json

Schema

Schema

walletId uuidrequired

Wallet ID of the transaction

id uuidrequired

Unique ID of the transaction

shortId stringrequired

Short ID of the transaction

externalId stringrequired

External ID of the transaction

type stringrequired

Possible values: [PAYMENT, DEPOSIT, CHARGE, EXCHANGE, OTHER_CREDIT_DEBIT]

Type of the transaction

status objectrequired

Status of the transaction

state stringrequired

Possible values: [FUNDS_REQUIRED, PENDING, AWAITING_APPROVAL, PROCESSING, SUCCESS, FAILED, REVERSED]

State of the transaction

reason string

Reason for the transaction state

complete boolean

Completion status of the transaction

amount objectrequired

amount numberrequired

The specific monetary value that is being converted from in the currency exchange

currency stringrequired

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

senderAccountIdentifier stringrequired

Sender's account identifier for the deposit

senderName stringrequired

Name of the sender for the deposit

senderReference stringrequired

Reference for the sender's deposit

payment object

Details of the payment transaction

beneficiaryAccountIdentifier stringrequired

Beneficiary's account identifier for the payment

beneficiaryName stringrequired

Name of the beneficiary for the payment

paymentReference stringrequired

Reference for the payment

exchange object

Details of the exchange transaction

rate objectrequired

Rate of the exchange

price numberrequired

currencyPair stringrequired

type stringrequired

Possible values: [BID, OFFER]

from objectrequired

amount numberrequired

The specific monetary value that is being converted from in the currency exchange

currency stringrequired

Possible values: Value must match regular expression [A-Z]{3}

The type of currency that the money is being exchanged from

to objectrequired

amount numberrequired

The specific monetary value that is being converted from in the currency exchange

currency stringrequired

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

chargeForTransactionId string

Charge for the transaction ID

createdAt date-timerequired

Creation time of the transaction

completedAt date-time

Completion time of the transaction

Example (from schema)

{
  "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"
}

400

Bad Request

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

401

Unauthorized

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

403

Forbidden

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

404

Not Found

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

405

Method Not Allowed

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

415

Unsupported Media Type

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

429

Too Many Requests

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

500

Internal Server Error

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "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

walletId uuidrequired

Wallet ID of the transaction

id uuidrequired

Unique ID of the transaction

shortId stringrequired

Short ID of the transaction

externalId stringrequired

External ID of the transaction

type stringrequired

Possible values: [PAYMENT, DEPOSIT, CHARGE, EXCHANGE, OTHER_CREDIT_DEBIT]

Type of the transaction

status objectrequired

Status of the transaction

state stringrequired

Possible values: [FUNDS_REQUIRED, PENDING, AWAITING_APPROVAL, PROCESSING, SUCCESS, FAILED, REVERSED]

State of the transaction

reason string

Reason for the transaction state

complete boolean

Completion status of the transaction

amount objectrequired

amount numberrequired

The specific monetary value that is being converted from in the currency exchange

currency stringrequired

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

senderAccountIdentifier stringrequired

Sender's account identifier for the deposit

senderName stringrequired

Name of the sender for the deposit

senderReference stringrequired

Reference for the sender's deposit

payment object

Details of the payment transaction

beneficiaryAccountIdentifier stringrequired

Beneficiary's account identifier for the payment

beneficiaryName stringrequired

Name of the beneficiary for the payment

paymentReference stringrequired

Reference for the payment

exchange object

Details of the exchange transaction

rate objectrequired

Rate of the exchange

price numberrequired

currencyPair stringrequired

type stringrequired

Possible values: [BID, OFFER]

from objectrequired

amount numberrequired

The specific monetary value that is being converted from in the currency exchange

currency stringrequired

Possible values: Value must match regular expression [A-Z]{3}

The type of currency that the money is being exchanged from

to objectrequired

amount numberrequired

The specific monetary value that is being converted from in the currency exchange

currency stringrequired

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

chargeForTransactionId string

Charge for the transaction ID

createdAt date-timerequired

Creation time of the transaction

completedAt date-time

Completion time of the transaction

Callbacks Responses

200

None 200 will be retried with exponential backoff upto 7 days

Loading...