Subscribe to payment events
POST/api/v1/payments/subscribe
Subscribe to updates across all payments
Request
- application/json
Body
required
Responses
- 201
- 400
- 401
- 403
- 404
- 405
- 415
- 429
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
Unique identifier for the payment
status object
Status of a payment
Possible values: [DRAFT
, CANCELLED
, PENDING_APPROVAL
, DUE
, PAID
]
The state of a payment
The reason for the status of a payment
Payment status
Creation time of the payment
Completion time of the payment
External ID of the payment
Quote ID associated with the payment
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
Reference for the payment
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
Beneficiary ID associated with the payment
Document reference associated with the payment
document object
Receipt file in Base64-encoded format
The MIME type of the file, such as 'application/pdf' for a PDF file or 'image/jpeg' for a JPEG image
The name of the file, including the file extension
{
"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"
}
}
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 Payment webhook
POST$request.body.callbackUrl
- application/json
Body
required
Request body to be implemented
Unique identifier for the payment
status object
Status of a payment
Possible values: [DRAFT
, CANCELLED
, PENDING_APPROVAL
, DUE
, PAID
]
The state of a payment
The reason for the status of a payment
Payment status
Creation time of the payment
Completion time of the payment
External ID of the payment
Quote ID associated with the payment
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
Reference for the payment
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
Beneficiary ID associated with the payment
Document reference associated with the payment
document object
Receipt file in Base64-encoded format
The MIME type of the file, such as 'application/pdf' for a PDF file or 'image/jpeg' for a JPEG image
The name of the file, including the file extension
The content of the file, encoded as a Base64 string
Callbacks Responses
- 200
None 200 will be retried with exponential backoff upto 7 days