Error
A valid request URL is required to generate request examples{
"success": true,
"message": "Checkout Created successfully created.",
"data": {
"fullName": "John Doe",
"paymentMethod": "PAYBYBANK",
"currency": "ZAR",
"amount": 10,
"phoneNumber": "+245XXXXXXXXX",
"country": "<string>",
"referenceId": "5f9b2c7b9c9d6b0017b4e6b1",
"callbackUrl": "https://example.com",
"customerRedirectUrl": "https://example.com/success",
"idNumber": "9001010000084",
"forceDefaultMethod": false
}
}{
"success": false,
"message": "Bad Request",
"data": {}
}{
"success": false,
"message": "Unauthorized",
"data": {}
}Bank Deposits
Bank Checkout Deposit
Customer Completed transaction using Checkout Url
POST
/
api
/
v3
/
deposit
/
bank
/
checkout
Error
A valid request URL is required to generate request examples{
"success": true,
"message": "Checkout Created successfully created.",
"data": {
"fullName": "John Doe",
"paymentMethod": "PAYBYBANK",
"currency": "ZAR",
"amount": 10,
"phoneNumber": "+245XXXXXXXXX",
"country": "<string>",
"referenceId": "5f9b2c7b9c9d6b0017b4e6b1",
"callbackUrl": "https://example.com",
"customerRedirectUrl": "https://example.com/success",
"idNumber": "9001010000084",
"forceDefaultMethod": false
}
}{
"success": false,
"message": "Bad Request",
"data": {}
}{
"success": false,
"message": "Unauthorized",
"data": {}
}Customer completed transaction using checkout URL. This endpoint allows customers to deposit funds via bank checkout.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
full name
Example:
"John Doe"
Payment Method
Available options:
PAYBYBANK, CARD, CAPITECPAY Example:
"PAYBYBANK"
Transaction currency
Example:
"ZAR"
amount to deposit
Example:
10
Customer Phone Number
Example:
"+245XXXXXXXXX"
Country where the wallet is used (optional if derivable from currency) - Cards are accepted globally
reference id
Example:
"5f9b2c7b9c9d6b0017b4e6b1"
callback url
Example:
"https://example.com"
customer redirect url
Example:
"https://example.com/success"
Customer national ID number (required for Capitec Pay in South Africa - 13 digit SA ID)
Example:
"9001010000084"
Show only the chosen paymentMethod to the customer, where the provider supports it.
Example:
false