Split information allows a single transaction amount to be shared into multiple accounts. This basically allows transaction amount sharing between multiple parties as at when the transaction is been performed.
1 |
Request Endpoint: /api/v3/purchases |
Sample Request Body
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
{ "customerId":"ava@avacute.com", // Email, mobile number, BVN etc to uniquely identify the customer. "amount":"295000", // Amount in Naira. "transactionRef":"AVA-1601984425404", // Unique transaction reference number. "currency":"NGN", // ISO Currency code. "authData":"QZ37cwXQW9XcY8DOXrV1UhUV0ZG/M42jrUVS0693XXDOZqaC7U7gvXoiLe2IccbyIyBpyedtriKrPS8j7ywEqMwT9Eub4BnS4MjT4rls8fBcGjukw65evCsTHkXeJunXaL0U2bnhehDt80NaRSxCG/1mrlH0G1RIMsNVkhvlv+a6iTU6dpR5PZ4PtcjIy8fK8Ma4MsOLU6zRr+/hAZoqVkWhmUzz3Dv6hQmY/siuAf1+obEdArGfj9cV0AFX5TAkotM425w2nDedGVqkDqTgww4cJNzbSvzWb2yrptvC5Ky2O2SXAJcPDqczB7SoL07Zq0RuOnwLHq7RZh43e+7jCA==", // authdata "splitSettlementInformation": [ { "alias":"SPLIT_6", // A known account alias "amount":"14425", // Amount to settle to account "isPrimary":true // Primary status }, { "alias":"SPLIT_3", // A known account alias "amount":"280575", // Amount to settle to account "isPrimary":false // Account primary status } ] } |
Sample Success Response
1 2 3 4 5 6 7 8 |
{ "transactionRef": "AVA-1601984425404", "paymentId": "949933", "message": "Kindly enter the OTP sent to 234802***8000 and tony5******mail.com", "amount": "295000.00", "responseCode": "T0", "plainTextSupportMessage": "Didn't get the OTP? Dial *322*0# on your phone (MTN, Etisalat, Airtel) Glo, use *805*0#." } |
Sample Failed Response
1 2 3 4 5 6 7 8 9 |
{ "transactionRef": "AVA-1601984425405", "errors": [ { "code": "10400", "message": "Invalid account or alias in split settlement instruction, settlement account must have been pre-configured by merchant admin!" } ] } |
1 2 3 4 5 6 7 8 9 10 |
{ "transactionRef": "AVA-1601984425406", "errors": [ { "code": "10400", "message": "Settlement account must have been pre-configured by merchant admin!" } ] } |