Subscribe to payment events

POST 
/api/v1/payments/subscribe

Subscribe to updates across all payments

Request

application/json

Body

required

callbackUrl stringrequired
sharedKey stringrequired
headerKey string
headerValue string

Responses

201

Created

application/json

Schema

Schema

id uuidrequired

Unique identifier for the payment

status object

Status of a payment

state stringrequired

Possible values: [DRAFT, CANCELLED, PENDING_APPROVAL, DUE, PAID]

The state of a payment

reason string

The reason for the status of a payment

complete boolean

Payment status

createdAt date-timerequired

Creation time of the payment

completedAt date-time

Completion time of the payment

externalId stringrequired

External ID of the payment

quoteId uuidrequired

Quote ID associated with the payment

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

reference stringrequired

Reference for the payment

purposeOfPayment stringrequired

Possible values: [COMPUTER_SERVICES, FAMILY_SUPPORT, EDUCATION, MEDICAL_TREATMENT, MAINTENANCE_EXPENSES, TRAVEL, SMALL_VALUE_REMITTANCE, CONSTRUCTION_EXPENSES, HOTEL_ACCOMMODATION, ADVERTISING_EXPENSES, ADVISORY_FEES, BUSINESS_INSURANCE, INSURANCE_CLAIMS, DELIVERY_FEES, EXPORTED_GOODS, SERVICE_CHARGES, LOAN_PAYMENT, OFFICE_EXPENSES, PROPERTY_PURCHASE, PROPERTY_RENTAL, ROYALTY_FEES, SHARES_INVESTMENT, FUND_INVESTMENT, TAX_PAYMENT, TRANSPORTATION_FEES, UTILITY_BILLS, PERSONAL_TRANSFER, SALARY_PAYMENT, INFLUENCER_PAYMENT, DIVIDEND_PAYMENT, OTHER_FEES, OTHER]

Purpose of the payment

beneficiaryId uuidrequired

Beneficiary ID associated with the payment

documentReference string

Document reference associated with the payment

document object

Receipt file in Base64-encoded format

mediaType stringrequired

The MIME type of the file, such as 'application/pdf' for a PDF file or 'image/jpeg' for a JPEG image

name stringrequired

The name of the file, including the file extension

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": {
    "state": "DRAFT",
    "reason": "string",
    "complete": false
  },
  "createdAt": "2023-01-01T00:00:00Z",
  "completedAt": "2023-01-01T00:00:00Z",
  "externalId": "EXT123",
  "quoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amount": {
    "amount": 100,
    "currency": "USD"
  },
  "reference": "REF123",
  "purposeOfPayment": "COMPUTER_SERVICES",
  "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documentReference": "DOC123",
  "document": {
    "mediaType": "application/pdf",
    "name": "document.pdf"
  }
}

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 Payment webhook

POST 
$request.body.callbackUrl

application/json

Body

required

Request body to be implemented

id uuidrequired

Unique identifier for the payment

status object

Status of a payment

state stringrequired

Possible values: [DRAFT, CANCELLED, PENDING_APPROVAL, DUE, PAID]

The state of a payment

reason string

The reason for the status of a payment

complete boolean

Payment status

createdAt date-timerequired

Creation time of the payment

completedAt date-time

Completion time of the payment

externalId stringrequired

External ID of the payment

quoteId uuidrequired

Quote ID associated with the payment

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

reference stringrequired

Reference for the payment

purposeOfPayment stringrequired

Possible values: [COMPUTER_SERVICES, FAMILY_SUPPORT, EDUCATION, MEDICAL_TREATMENT, MAINTENANCE_EXPENSES, TRAVEL, SMALL_VALUE_REMITTANCE, CONSTRUCTION_EXPENSES, HOTEL_ACCOMMODATION, ADVERTISING_EXPENSES, ADVISORY_FEES, BUSINESS_INSURANCE, INSURANCE_CLAIMS, DELIVERY_FEES, EXPORTED_GOODS, SERVICE_CHARGES, LOAN_PAYMENT, OFFICE_EXPENSES, PROPERTY_PURCHASE, PROPERTY_RENTAL, ROYALTY_FEES, SHARES_INVESTMENT, FUND_INVESTMENT, TAX_PAYMENT, TRANSPORTATION_FEES, UTILITY_BILLS, PERSONAL_TRANSFER, SALARY_PAYMENT, INFLUENCER_PAYMENT, DIVIDEND_PAYMENT, OTHER_FEES, OTHER]

Purpose of the payment

beneficiaryId uuidrequired

Beneficiary ID associated with the payment

documentReference string

Document reference associated with the payment

document object

Receipt file in Base64-encoded format

mediaType stringrequired

The MIME type of the file, such as 'application/pdf' for a PDF file or 'image/jpeg' for a JPEG image

name stringrequired

The name of the file, including the file extension

base64EncodedFile stringrequired

The content of the file, encoded as a Base64 string

Callbacks Responses

200

None 200 will be retried with exponential backoff upto 7 days

Loading...