{"info":{"_postman_id":"040263c3-aed9-4046-90a0-1f815602d470","name":"MagmaSend API V2","description":"

Magmasend API is organised around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

\n

Magmasend will provide you in a separate way the BASEURL value

\n

Your server Ip must be whitelisted in order to use the api

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16428553","collectionId":"040263c3-aed9-4046-90a0-1f815602d470","publishedId":"UVBzm8za","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-11-02T08:04:04.000Z"},"item":[{"name":"Authentication","item":[{"name":"Auth","id":"6cddc09f-0c98-4a54-944d-1f3596cad291","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"YOUR_API_EMAIL\",\n \"password\": \"YOUR_API_PASSWORD\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v1/oauth/login","description":"

Magmasend API requires an Access token, based on your credentials (email and password).

\n\n

Request Information

\n","urlObject":{"path":["v1","oauth","login"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"5007065a-d86b-4616-8f6d-e7c848df58e1","name":"SUCCESS","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"YOUR_API_EMAIL\",\n \"password\": \"YOUR_API_PASSWORD\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v1/oauth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:34:53 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"579"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"00\",\n \"status\": \"OK\",\n \"access_token\": \"YOUR_TOKEN\",\n \"token_type\": \"bearer\",\n \"expires_in\": 86399\n}"},{"id":"97e5bce7-49f3-4d43-8d25-c8156b22e927","name":"ERROR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"YOUR_API_EMAIL\",\n \"password\": \"YOUR_API_PASSWORD\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v1/oauth/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:35:24 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"578"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"-4\",\n \"status\": \"INVALID_CREDENTIALS\"\n}"}],"_postman_id":"6cddc09f-0c98-4a54-944d-1f3596cad291"}],"id":"9ee63244-cd37-469b-8efe-1ac269fec39a","_postman_id":"9ee63244-cd37-469b-8efe-1ac269fec39a","description":""},{"name":"Balance","item":[{"name":"Balance","id":"e5fdeb45-f88f-42e5-a318-f8bb918c5181","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"GET","header":[],"url":"BASE_URL/v2/balance","description":"

This endpoint will return your balance on Magmasend

\n

Request Information

\n","urlObject":{"path":["v2","balance"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"ffda80be-06f1-4b12-b024-b9219b6e959e","name":"SUCCESS","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":"BASE_URL/v2/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:36:52 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"579"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"00\",\n \"status\": \"OK\",\n \"balance\": {\n \"currency\": \"XOF\",\n \"balance\": 5182\n }\n}"},{"id":"8e81d857-57f8-40b8-996f-98691f053682","name":"ERROR","originalRequest":{"method":"GET","header":[],"url":"BASE_URL/v2/balance"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:37:20 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"-5\",\n \"status\": \"INVALID_TOKEN\"\n}"}],"_postman_id":"e5fdeb45-f88f-42e5-a318-f8bb918c5181"}],"id":"87e533c0-916f-48bb-8b60-43e26a67fbb9","_postman_id":"87e533c0-916f-48bb-8b60-43e26a67fbb9","description":""},{"name":"Customers","item":[{"name":"Create new customer","id":"1b8c6afa-f3d2-4d9e-9dee-415e375dbfb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"type\": \"sender\",\n\t\"first_name\": \"John\",\n\t\"last_name\": \"Doe\",\n\t\"phone_number\": \"+22507010201\",\n\t\"birth_country\": \"CI\",\n\t\"birth_city\": \"Abidjan\",\n\t\"birth_date\": \"1990-01-01\",\n\t\"poi_type\": \"NationalID\",\n\t\"poi_id\": \"123456789\",\n\t\"nationality\": \"CI\",\n\t\"residence_country\": \"CI\",\n\t\"residence_city\": \"Abidjan\",\n\t\"residence_address\": \"Abchurch Lane and Abchurch Yard\",\n \"partner_reference\": \"REF001\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/customer","description":"

This API will be used to register Customer / Beneficiary in MagmaSend System. reference will be returned in response on this API. This reference will be the unique identifier of each Customer/Beneficiary registered by partner through API. While sending
remittance, Partner will provide this unique reference to identify the Customer/Beneficiary of that remittance.

\n

Request Information

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter NameTypeMandatoryDescription
typeStringMandatoryCustomer type : sender or receiver
partner_referenceStringOptionalYour customer reference on your system
first_nameStringMandatoryFist name of customer
last_nameStringMandatoryLast name of customer
phone_numberStringMandatoryPhone number on E 164 format
birth_countryISO2 codeMandatory only for SenderBirth Country of customer
birth_cityStringMandatory only for SenderBirth City of customer
birth_dateYYYY-MM-DDMandatory only for SenderBirth Date of customer
poi_typeStringMandatory only for SenderProof of identity type : Passport or NationalID or DrivingLicense or ConsularCard
poi_idStringMandatory only for SenderProof of identity reference
nationalityStringMandatory only for SenderNationality of customer
residence_countryISO2 codeMandatoryLiving country of customer
residence_cityStringMandatoryLiving city of customer
residence_addressStringMandatory only for ReceiverLiving address of customer
\n
","urlObject":{"path":["v2","customer"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"371bd709-26ed-4d8a-a58e-6f76d138fc28","name":"SUCCESS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"type\": \"sender\",\n\t\"first_name\": \"John\",\n\t\"last_name\": \"Doe\",\n\t\"phone_number\": \"+22507010203\",\n\t\"birth_country\": \"CI\",\n\t\"birth_city\": \"Abidjan\",\n\t\"birth_date\": \"1990-01-01\",\n\t\"poi_type\": \"NationalID\",\n\t\"poi_id\": \"123456789\",\n\t\"nationality\": \"Ci\",\n\t\"residence_country\": \"Ci\",\n\t\"residence_city\": \"Abidjan\",\n\t\"residence_address\": \"Abchurch Lane and Abchurch Yard\",\n \"partner_reference\": \"REF001\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/customer"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:39:20 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"578"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 201,\n \"status\": \"CREATED\",\n \"customer\": {\n \"type\": \"sender\",\n \"reference\": \"00F7531E36\"\n }\n}"},{"id":"a5f2393f-df1d-4c96-8015-157bad438475","name":"ERROR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"sender\",\n\t\"first_name\": \"John\",\n\t\"last_name\": \"Doe\",\n\t\"phone_number\": \"+22507010201\",\n\t\"birth_country\": \"CI\",\n\t\"birth_city\": \"Abidjan\",\n\t\"poi_type\": \"NationalID\",\n\t\"poi_id\": \"123456789\",\n\t\"nationality\": \"CI\",\n\t\"residence_country\": \"CI\",\n\t\"residence_city\": \"Abidjan\",\n\t\"residence_address\": \"Abchurch Lane and Abchurch Yard\",\n \"partner_reference\": \"REF001\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/customer"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:40:30 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"576"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"status\": \"DATA_NOT_VALID\",\n \"comment\": \"Data provided is not valid\",\n \"description\": {\n \"first_name\": \"The first name field is required.\",\n \"last_name\": \"The last name field is required.\",\n \"country\": \"The country field is required.\",\n \"city\": \"The city field is required.\",\n \"address_line_1\": \"The address line 1 field is required.\"\n }\n}"}],"_postman_id":"1b8c6afa-f3d2-4d9e-9dee-415e375dbfb3"},{"name":"Get customer by reference","id":"3552d76e-1f8a-4dde-a58a-2446b46564d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"GET","header":[],"url":"BASE_URL/v2/customer/YOUR_CUSTOMER_REFERENCE","description":"

This API will be used to get Customer / Beneficiary information in MagmaSend System.

\n

You can use either Magma customer reference or your reference (partner_reference) to retrieve information

\n","urlObject":{"path":["v2","customer","YOUR_CUSTOMER_REFERENCE"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"2e35d826-1fe4-4111-8ef0-3bf838cad7b2","name":"SUCCESS","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":"BASE_URL/v2/customer/YOUR_CUSTOMER_REFERENCE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:41:24 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"578"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"status\": \"OK\",\n \"customer\": {\n \"type\": \"sender\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"+22507010203\",\n \"birth_country\": \"GB\",\n \"birth_city\": \"London\",\n \"birth_date\": \"1990-01-01\",\n \"poi_type\": \"NationalID\",\n \"poi_id\": \"123456789\",\n \"nationality\": \"CI\",\n \"country\": \"GB\",\n \"city\": \"London\"\n }\n}"},{"id":"eecd285b-ed6e-4307-b355-950231b139b8","name":"ERROR","originalRequest":{"method":"GET","header":[],"url":"BASE_URL/v2/customer/YOUR_CUSTOMER_REFERENCE"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:41:45 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"577"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"status\": \"NOT_FOUND\",\n \"comment\": \"reference you requested does not exist\"\n}"}],"_postman_id":"3552d76e-1f8a-4dde-a58a-2446b46564d2"},{"name":"Update Customer information","id":"ae2e516d-fa8a-4d18-a6e2-5c3d9c750ddb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"first_name\": \"John\",\n\t\"last_name\": \"Doe\",\n\t\"phone_number\": \"+22507010203\",\n\t\"birth_country\": \"GB\",\n\t\"birth_city\": \"London\",\n\t\"birth_date\": \"1990-01-01\",\n\t\"poi_type\": \"NationalID\",\n\t\"poi_id\": \"123456789\",\n\t\"nationality\": \"CI\",\n\t\"residence_country\": \"GB\",\n\t\"residence_city\": \"London\",\n\t\"residence_address\": \"Abchurch Lane and Abchurch Yard\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/customer/YOUR_CUSTOMER_REFERENCE","description":"

This API will be used to register Customer / Beneficiary in MagmaSend System. reference will be returned in response on this API. This reference will be the unique identifier of each Customer/Beneficiary registered by partner through API. While sending\nremittance, Partner will provide this unique reference to identify the Customer/Beneficiary of that remittance.

\n

Request Information

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter NameTypeMandatoryDescription
typeStringMandatoryCustomer type : sender or receiver
first_nameStringMandatoryFist name of customer
last_nameStringMandatoryLast name of customer
phone_numberStringMandatoryPhone number on E 164 format
birth_countryISO2 codeMandatory only for SenderBirth Country of customer
birth_cityStringMandatory only for SenderBirth City of customer
birth_dateYYYY-MM-DDMandatory only for SenderBirth Date of customer
poi_typeStringMandatory only for SenderProof of identity type : Passport or NationalID or DrivingLicense or ConsularCard
poi_idStringMandatory only for SenderProof of identity reference
nationalityStringMandatory only for SenderNationality of customer
residence_countryISO2 codeMandatoryLiving country of customer
residence_cityStringMandatoryLiving city of customer
residence_addressStringMandatory only for ReceiverLiving address of customer
\n
","urlObject":{"path":["v2","customer","YOUR_CUSTOMER_REFERENCE"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"c1a840b3-df41-4583-a443-00c01eea4f56","name":"SUCCESS","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"first_name\": \"John\",\n\t\"last_name\": \"Doe\",\n\t\"phone_number\": \"+22507010203\",\n\t\"birth_country\": \"GB\",\n\t\"birth_city\": \"London\",\n\t\"birth_date\": \"1990-01-01\",\n\t\"poi_type\": \"NationalID\",\n\t\"poi_id\": \"123456789\",\n\t\"nationality\": \"CI\",\n\t\"residence_country\": \"GB\",\n\t\"residence_city\": \"London\",\n\t\"residence_address\": \"Abchurch Lane and Abchurch Yard\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/customer/YOUR_CUSTOMER_REFERENCE"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.0.12"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:42:00 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"576"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 202,\n \"status\": \"ACCEPTED\",\n \"comment\": \"Customer updated successfully\",\n \"customer\": {\n \"type\": \"sender\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"+22507010203\",\n \"birth_country\": \"GB\",\n \"birth_city\": \"London\",\n \"birth_date\": \"1990-01-01\",\n \"poi_type\": \"NationalID\",\n \"poi_id\": \"123456789\",\n \"nationality\": \"CI\",\n \"country\": \"GB\",\n \"city\": \"London\"\n }\n}"},{"id":"1414ae27-752a-4a53-9914-6262241e7deb","name":"ERROR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"first_name\": \"John\",\n\t\"last_name\": \"Doe\",\n\t\"phone_number\": \"+22507010203\",\n\t\"birth_country\": \"GB\",\n\t\"birth_city\": \"London\",\n\t\"birth_date\": \"1990-01-01\",\n\t\"poi_type\": \"NationalID\",\n\t\"poi_id\": \"123456789\",\n\t\"nationality\": \"CI\",\n\t\"residence_country\": \"GB\",\n\t\"residence_city\": \"London\",\n\t\"residence_address\": \"Abchurch Lane and Abchurch Yard\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/customer/YOUR_CUSTOMER_REFERENCE"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:42:35 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"579"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"status\": \"NOT_FOUND\",\n \"comment\": \"reference you requested does not exist\"\n}"}],"_postman_id":"ae2e516d-fa8a-4d18-a6e2-5c3d9c750ddb"}],"id":"473cd4e2-e4b7-4c38-9c54-1256c44b62e7","_postman_id":"473cd4e2-e4b7-4c38-9c54-1256c44b62e7","description":""},{"name":"Transactions","item":[{"name":"Create new transaction","id":"44d24a51-9b67-4170-beaa-45487606c674","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"transaction_id\": \"3ac856ca-32af-4e8b-80bd-c2ba830d3430\",\n\t\"notify_url\": \"https://m.com\",\n\t\"payment_method\": \"MobileMoney\",\n\t\"payout_amount\": 1000,\n\t\"payout_currency\": \"XOF\",\n\t\"payout_country\": \"CI\",\n\t\"relation\": \"Love\",\n\t\"sender_reference\": \"YOUR_CUSTOMER_REFERENCE\",\n\t\"receiver_reference\": \"YOUR_CUSTOMER_REFERENCE\",\n\t\"receiver_phone_number\": \"+2250707895086\",\n\t\"receiver_bank_code\": \"String\",\n\t\"receiver_bank_name\": \"String\",\n\t\"receiver_account_number\": \"String\",\n\t\"receiver_branch_code\": \"String\",\n\t\"receiver_sort_code\": \"String\",\n \"receiver_company_name\": \"String\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/transaction","description":"

This allow you to send money in Magmasend Payout Network

\n

Magma Corridors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CountryAccount TransferCash PickupMobile WalletCurrency
Cote d'IvoireYesYesYesXOF
MaliYesYesYesXOF
Burkina FasoYesYesYesXOF
SenegalYesYesYesXOF
TogoYesYesYesXOF
BeninYesYesYesXOF
Guinée BissauYesNoNoXOF
NigerYesNoNoXOF
CamerounYesYesYesXAF
Central African RepublicYesNoNoXAF
ChadYesNoNoXAF
CongoYesYesYesXAF
Equatorial GuineaYesNoYesXAF
GabonYesNoYesXAF
GhanaYesYesYesGHS
\n

Status list

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusDescription
WAITING_PARTNER_CONFIRMATIONTransaction must be confirmed by sender partner in order to be processing
NEWTransaction is waiting to be processing
PENDINGTransaction is on processing
SUCCESSTransaction has been successfully processed
FAILEDTransaction has failed for any reason
INSUFFICIENT_FUNDSYou don't have enough fund for processing the transaction
CANCELEDTransaction has been canceled
REFUNDEDTransaction has been refunded
\n

Request Information

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter NameTypeMandatoryDescription
transaction_idStringMandatoryYour transaction Id
notify_urlUrlMandatoryCallback URL, this url will be called after an update on the transaction
payment_methodStringMandatoryDelivery Method : MobileMoney for mobile wallet payment or CashPickup for Cash Pickup or AccountTransfer for wire transfer or
WAVE for wave wallet transfer
payout_amountIntegerMandatoryAmount the receiver should get
payout_currencyISO3 currencyMandatoryCurrency of the amount the receiver should get
payout_countryISO2 countryMandatoryCountry of the receiver
relationStringMandatoryRelation with the sender and the receiver
sender_referenceStringMandatoryCustomer reference of the sender
receiver_referenceStringMandatoryCustomer reference of the receiver
receiver_phone_numberStringMandatory only for MOBILE_MONEY and WAVECustomer mobile number for wallet payment
receiver_bank_nameStringMandatory only for ACCOUNT_TRANSFERCustomer's Bank Name
receiver_bank_addressStringMandatory only for ACCOUNT_TRANSFERCustomer's Bank Address
receiver_bank_account_numberStringMandatory only for ACCOUNT_TRANSFERCustomer's International Bank Account Number
receiver_bank_sort_codeStringMandatory only for ACCOUNT_TRANSFERCustomer Branch code
receiver_company_nameStringOptional, only for ACCOUNT_TRANSFERAccount Business Name
\n
","urlObject":{"path":["v2","transaction"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"949007e9-14d1-40d3-ba5e-269c09214f06","name":"Create new transaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"transaction_id\": \"728e2c39-a151-45f0-ba63-f46dfc66072f\",\n\t\"notify_url\": \"https://m.com\",\n\t\"payment_method\": \"MobileMoney\",\n\t\"payout_amount\": 1000,\n\t\"payout_currency\": \"XOF\",\n\t\"payout_country\": \"CI\",\n\t\"relation\": \"Love\",\n\t\"sender_reference\": \"YOUR_CUSTOMER_REFERENCE\",\n\t\"receiver_reference\": \"YOUR_CUSTOMER_REFERENCE\",\n\t\"receiver_phone_number\": \"+2250707895086\",\n\t\"receiver_bank_code\": \"String\",\n\t\"receiver_bank_name\": \"String\",\n\t\"receiver_account_number\": \"String\",\n\t\"receiver_branch_code\": \"String\",\n\t\"receiver_sort_code\": \"String\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/transaction"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:44:41 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"579"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 201,\n \"status\": \"CREATED\",\n \"comment\": \"Transaction initiated successfully, you should confirm it now\",\n \"transaction\": {\n \"reference\": 82435064225,\n \"transaction_id\": \"5IM2GKYRDDLB7SD\",\n \"payment_method\": \"MobileMoney\",\n \"payout_amount\": 1000,\n \"payout_country\": \"CI\",\n \"sending_currency\": \"XOF\",\n \"sending_amount\": 1000,\n \"sending_fee_amount\": 10,\n \"exchange_rate\": 1,\n \"sender_reference\": \"C6CA6EDECE\",\n \"receiver_reference\": \"7978976A0A\",\n \"status\": \"WAITING_PARTNER_CONFIRMATION\",\n \"comment\": \"This transaction must be confirmed by sender partner\"\n }\n}"},{"id":"8c5b53c4-ec42-4420-9546-df5ed676bb0d","name":"ERROR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"transaction_id\": \"8a267a60-65d6-401c-abb7-71044271daad\",\n\t\"notify_url\": \"https://m.com\",\n\t\"payment_method\": \"CashPickup\",\n\t\"payout_amount\": 1000,\n\t\"payout_currency\": \"XAF\",\n\t\"payout_country\": \"CI\",\n\t\"relation\": \"Love\",\n\t\"sender_reference\": \"YOUR_CUSTOMER_REFERENCE\",\n\t\"receiver_reference\": \"YOUR_CUSTOMER_REFERENCE\",\n\t\"receiver_phone_number\": \"+2250707895086\",\n\t\"receiver_bank_code\": \"String\",\n\t\"receiver_bank_name\": \"String\",\n\t\"receiver_account_number\": \"String\",\n\t\"receiver_branch_code\": \"String\",\n\t\"receiver_sort_code\": \"String\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/transaction"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:45:56 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"579"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"status\": \"DATA_NOT_VALID\",\n \"comment\": \"payout_currency is not available for the payout_country\"\n}"}],"_postman_id":"44d24a51-9b67-4170-beaa-45487606c674"},{"name":"Confirm transaction","id":"b8c953e1-8f11-4a60-a2ab-d666c6b3efc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"reference\":\"YOUR_TRANSACTION_REFERENCE\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/transaction/confirm","description":"

Each transaction initiated need to be confirm

\n","urlObject":{"path":["v2","transaction","confirm"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"a5472b89-1c3f-4ca3-ad9f-884d0de6b786","name":"SUCCESS","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference\":\"YOUR_TRANSACTION_REFERENCE\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/transaction/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:49:41 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"578"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"status\": \"OK\",\n \"comment\": \"Transaction confirmed successfully\",\n \"transaction\": {\n \"reference\": \"58109462690\",\n \"collection_pin\": \"103012956\",\n \"transaction_id\": \"PONXBTYNRD4564D\",\n \"payment_method\": \"CashPickup\",\n \"payout_amount\": 1000,\n \"payout_currency\": \"XOF\",\n \"payout_country\": \"CI\",\n \"sending_currency\": \"XOF\",\n \"sending_amount\": \"1000\",\n \"sending_fee_amount\": \"150\",\n \"exchange_rate\": \"1\",\n \"sender_reference\": \"C6CA6EDECE\",\n \"receiver_reference\": \"7978976A0A\",\n \"status\": \"PENDING\",\n \"comment\": \"Payment on process\"\n }\n}"},{"id":"48744666-76d7-44d2-9515-7518e714eb8d","name":"ERROR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference\":\"YOUR_TRANSACTION_REFERENCE\"\n}","options":{"raw":{"language":"json"}}},"url":"BASE_URL/v2/transaction/confirm"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:46:29 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"578"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"status\": \"NOT_FOUND\",\n \"comment\": \"Transaction not found\"\n}"}],"_postman_id":"b8c953e1-8f11-4a60-a2ab-d666c6b3efc2"},{"name":"Get transaction by reference","id":"0f346fa7-c31e-4ecf-aaff-b0c4c54425d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"YOUR_TOKEN"}]},"isInherited":false},"method":"GET","header":[],"url":"BASE_URL/v2/transaction/YOUR_TRANSACTION_REFERENCE","description":"

That allows you to consult in real time the current status of a transfer.

\n

Request Information

\n","urlObject":{"path":["v2","transaction","YOUR_TRANSACTION_REFERENCE"],"host":["BASE_URL"],"query":[],"variable":[]}},"response":[{"id":"cd1a64b7-b9a1-48f6-bce1-dbce9e5c2bd0","name":"SUCCESS","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":"BASE_URL/v2/transaction/YOUR_TRANSACTION_REFERENCE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:52:32 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"579"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"status\": \"OK\",\n \"comment\": \"Transaction returned successfully\",\n \"transaction\": {\n \"reference\": \"58109462690\",\n \"collection_pin\": \"103012956\",\n \"transaction_id\": \"PONXBTYNRD4564D\",\n \"payment_method\": \"CashPickup\",\n \"payout_amount\": 1000,\n \"payout_currency\": \"XOF\",\n \"payout_country\": \"CI\",\n \"sending_currency\": \"XOF\",\n \"sending_amount\": \"1000\",\n \"sending_fee_amount\": \"150\",\n \"exchange_rate\": \"1\",\n \"sender_reference\": \"C6CA6EDECE\",\n \"receiver_reference\": \"7978976A0A\",\n \"status\": \"PENDING\",\n \"comment\": \"Payment on process\"\n }\n}"},{"id":"101a8284-4701-4610-8a5d-cfd1e09a1f2f","name":"ERROR","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer YOUR_TOKEN","type":"text"}],"url":"BASE_URL/v2/transaction/YOUR_TRANSACTION_REFERENCE"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 02 Nov 2021 07:52:59 GMT"},{"key":"X-RateLimit-Limit","value":"580"},{"key":"X-RateLimit-Remaining","value":"578"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 404,\n \"status\": \"NOT_FOUND\",\n \"comment\": \"Transaction not found\"\n}"}],"_postman_id":"0f346fa7-c31e-4ecf-aaff-b0c4c54425d8"},{"name":"Notification","id":"81d190a0-5037-4a2a-a5df-7ebdd0ec2edb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"reference\": \"30836586081\",\n\t\"transaction_id\": \"8URTMQJOW12VWM5\",\n\t\"payment_method\": \"MobileMoney\",\n\t\"payout_amount\": 2000,\n\t\"payout_currency\": \"XOF\",\n\t\"payout_country\": \"CI\",\n\t\"sending_currency\": \"XOF\",\n\t\"sending_amount\": \"2000\",\n\t\"sending_fee_amount\": \"1000\",\n\t\"exchange_rate\": \"1\",\n\t\"sender_reference\": \"C6CA6EDECE\",\n\t\"receiver_reference\": \"7978976A0A\",\n\t\"status\": \"SUCCESS\",\n\t\"comment\": \"Done with success\"\n}","options":{"raw":{"language":"json"}}},"url":"YOUR_NOTIFY_URL","description":"

When Transfer has a final status, Magmasend will send a notification to your notify_url with following params

\n","urlObject":{"host":["YOUR_NOTIFY_URL"],"query":[],"variable":[]}},"response":[],"_postman_id":"81d190a0-5037-4a2a-a5df-7ebdd0ec2edb"}],"id":"2e75e169-57f6-40c4-8f67-22c500fc2021","_postman_id":"2e75e169-57f6-40c4-8f67-22c500fc2021","description":""}],"event":[{"listen":"prerequest","script":{"id":"4149e5c7-fefd-428d-8d4f-60aad8ac043d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4c26545d-4446-420a-b54f-8b8f2d78b0ca","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"BASE_URL"},{"key":"transaction_reference","value":"YOUR_TRANSACTION_REFERENCE"},{"key":"reference1","value":"YOUR_CUSTOMER_REFERENCE"},{"key":"reference","value":"YOUR_CUSTOMER_REFERENCE"},{"key":"token","value":"YOUR_TOKEN"},{"key":"password","value":"YOUR_API_PASSWORD"},{"key":"email","value":"YOUR_API_EMAIL"}]}