Receive Money Flows
You can conveniently access the list of remittance firms working with Inswitch here: Inswitch
Introduction
Welcome to the Remittance Reception API documentation. This API allows you to integrate with our platform to manage and receive remittance transactions securely and efficiently. Whether you're building a financial application, a payment processing service, or an international money transfer solution, our API provides the necessary endpoints and functionalities to handle remittance operations seamlessly.
Key Features
- Secure Transactions: Ensure the safety and integrity of remittance data through robust authentication and encryption methods.
- Real-time Processing: Receive and process remittance transactions in real time, providing immediate feedback to users.
- Comprehensive Reporting: Access detailed transaction reports and analytics to monitor and optimize remittance operations.
- Scalability: Designed to handle high volumes of transactions, supporting your growth and scalability needs.
Remittance Reception Flow
In addition to the necessary authentication invocation required to use all our APIs, the steps for receiving remittances are as follows:
- Remittance Verification: Invoke the Quotations API, including all related remittance data. This API not only validates the existence of the remittance but also provides a valid quotation for 10 minutes, which can be used later for remittance collection.
- Remittance Payment: To confirm the remittance payment, use the Transactions API. In this invocation, you can use the quotation provided in the previous step to apply the FX rates and fees that were calculated..
Please note that there is also an option to pay for a remittance directly without going through the Quotations API. In this case, the remittance is queried and paid for in the same invocation.
API Call Example
Auth-Service API
curl --location --request POST 'https://{{baseUrl}}/auth-service/1.0/protocol/openid-connect/token' \
--header 'apikey: {{apikey}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username={{username}}' \
--data-urlencode 'password={{password}}'
{
"access_token": "{{access_token}}",
"expires_in": 300,
"refresh_expires_in": 1800,
"refresh_token": "{{refresh_token}}",
"token_type": "Bearer",
"not-before-policy": 0,
"session_state": "{{session_state}}",
"scope": "profile email"
}
Quotations API
curl --location 'https://gateway-am.apps.ins.inswhub.com/quotations/1.0/quotations/type/remittance' \
--header 'apikey: {{apikey}}' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'X-CorrelationID: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'X-Callback-URL: {{callbackUrl}}' \
'{
"amount": "100",
"currency": "USD",
"descriptionText": "Test",
"country": "NI",
"metadata": [],
"debitParty": {
"type": "remittancetnusdin-ni",
"data": {
"transfer_code": "9010001000528",
"document_type": "passport",
"document_number": "******8",
"document_country": "UY",
"document_issue_date": "2010-06-02",
"sender_full_name": "ROBERTO JARA RUIZ",
"first_name": "SEBASTIAN",
"last_name": "GONZALEZ",
"birth_country": "UY",
"nationality": "NI",
"country": "NI",
"relationship": "Pareja",
"address": "Direccion 1234",
"city": "Montevideo",
"state": "NI-CA",
"postal_code": "12100",
"birth_date": "1980-02-22"
}
},
"creditParty": {
"paymentMethodReference": "383839302D313030302D31323038"
}
}'
'{
"amount": "100.00000000",
"confirmed": true,
"country": "NI",
"creditParty": {
"data": {
"ACCOUNT_ID": "1000101"
},
"entityId": "1",
"paymentMethodReference": "383839302D313030302D31323038",
"type": "emoneyin-usd",
"typeClass": "emoneyin",
"typeCountry": null,
"walletId": "1000"
},
"currency": "USD",
"debitParty": {
"data": {
"address": "Direccion 1234",
"birth_country": "UY",
"birth_date": "1980-02-22",
"city": "Montevideo",
"country": "NI",
"document_country": "UY",
"document_issue_date": "2010-06-02",
"document_number": "*******",
"document_type": "passport",
"first_name": "SEBASTIAN",
"last_name": "GONZALEZ",
"nationality": "NI",
"postal_code": "12100",
"relationship": "Pareja",
"sender_full_name": "ROBERTO JARA RUIZ",
"state": "NI-CA",
"transfer_code": "9010001000528"
},
"type": "remittancetnusdin-ni",
"typeClass": "remittance",
"typeCountry": "NI"
},
"descriptionText": "Test",
"fees": {
"creditPartyEarnedCommission": "0.00000000",
"creditPartyNetCommission": "0.00000000",
"creditPartyPaidCommission": "0.00000000",
"debitPartyEarnedCommission": "0.00000000",
"debitPartyNetCommission": "0.00000000",
"debitPartyPaidCommission": "0.00000000"
},
"fx": {},
"geoCode": "",
"metadata": [
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_secondIdentificationExpirationDate",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_cityOfResidence",
"value": "HUMBLE"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_exchangeRateOriginationPayment",
"value": "1"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_settlementCurrency",
"value": "USD"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_agentId",
"value": "39208"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_dateOfTransfer",
"value": "2024-06-05"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_dateOfBirth",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_personId",
"value": "804222"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_provinceOfResidence",
"value": "TX"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_secondLastName",
"value": "RUIZ"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_paymentInfo_paymentTax",
"value": "0"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_settlementAmount",
"value": "100"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "remittanceCurrency",
"value": "USD"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "claimNumber",
"value": "9010001000528"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_provinceOfResidence",
"value": "OTR"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_paymentInfo_amountInDollars",
"value": "100"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_originatingCurrency",
"value": "USD"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_originatingCountryCode",
"value": "USA"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "message",
"value": "Transfer Info Request Successful."
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "remittanceAmount",
"value": "100"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_address",
"value": "AVENIDA890ESQEDISON3 "
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_identificationExpirationDate",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_countryOfResidence",
"value": "USA"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "businessUnitId",
"value": "0"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_identificationExpirationDate",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_countryOfResidence",
"value": "NIC"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_dateOfBirth",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_securitySocialNumber",
"value": "0"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_telephone",
"value": "83******523"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_personId",
"value": "804209"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_paymentType",
"value": "CASH"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_transactionType",
"value": "TRANSFER"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "returnCode",
"value": "11000"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transferId",
"value": "375662481"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_cityOfResidence",
"value": "CORTAZAR"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_lastName",
"value": "JARA"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_firstName",
"value": "ROBERTO"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "description",
"value": "Solicitud de información atendida exitosamente."
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_lastName",
"value": "GONZALEZ"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_firstName",
"value": "SEBASTIAN"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_postalCode",
"value": "77338"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_address",
"value": "8455WILLCLAYTONPKWY "
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_exchangeRateSettlementPayment",
"value": "1"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_transmitterId",
"value": "64"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_locationId",
"value": "PNI368"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transmitterCode",
"value": "1"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_secondIdentificationExpirationDate",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_paymentInfo_netPaymentAmount",
"value": "100"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_openTransfer",
"value": "true"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_exchangeRateOriginationSettlement",
"value": "1"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_originatingAmount",
"value": "100"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_originatingCountry",
"value": "1"
}
],
"paid": false,
"quotationCreationDate": "2024-06-06T21:16:59Z",
"quotationExpirationDate": "2024-06-06T21:17:59Z",
"quotationId": "1002508",
"quotationUsed": false,
"recipientKyc": {},
"requestingOrganisationTransactionReference": "",
"senderKyc": {},
"serviceCost": {
"details": [],
"totalCostInTransactionCurrency": "0.00000000",
"totalCostInUSD": "0.00000000"
},
"subType": "",
"type": "remittance"
}'
Transactions API
curl --location 'https://gateway-am.apps.ins.inswhub.com/transactions/1.0/transactions/type/remittance' \
--header 'apikey: {{apikey}}' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'X-CorrelationID: 201564a4-9a42-4dc2-af8d-4b4fd5043ec9' \
--header 'X-Callback-URL: {{callbackUrl}}' \
--header 'Content-Type: application/json' \
--data '{
"amount": "100",
"quotationId": "1002508",
"currency": "USD",
"descriptionText": "Test",
"country": "NI",
"metadata": [],
"debitParty": {
"type": "remittancetnusdin-ni",
"data": {
"transfer_code": "9010001000528",
"document_type": "passport",
"document_number": "*******",
"document_country": "UY",
"document_issue_date": "2010-06-02",
"sender_full_name": "ROBERTO JARA RUIZ",
"first_name": "SEBASTIAN",
"last_name": "GONZALEZ",
"birth_country": "UY",
"nationality": "NI",
"country": "NI",
"relationship": "Pareja",
"address": "Direccion 1234",
"city": "Montevideo",
"state": "NI-CA",
"postal_code": "12100",
"birth_date": "1980-02-22"
}
},
"creditParty": {
"paymentMethodReference": "383839302D313030302D31323038"
}
}
'
'{
"amount": "100.00000000",
"conciliationOptions": [],
"confirmed": true,
"country": "NI",
"creationDate": "2024-06-06T21:17:20.664987Z",
"creditParty": {
"data": {
"ACCOUNT_ID": "1000101"
},
"entityId": "1",
"paymentMethodReference": "383839302D313030302D31323038",
"type": "emoneyin-usd",
"typeClass": "emoneyin",
"typeCountry": null,
"walletId": "1000"
},
"currency": "USD",
"debitParty": {
"data": {
"address": "Direccion 1234",
"birth_country": "UY",
"birth_date": "1980-02-22",
"city": "Montevideo",
"country": "NI",
"document_country": "UY",
"document_issue_date": "2010-06-02",
"document_number": "*******",
"document_type": "passport",
"first_name": "SEBASTIAN",
"last_name": "GONZALEZ",
"nationality": "NI",
"postal_code": "12100",
"relationship": "Pareja",
"sender_full_name": "ROBERTO JARA RUIZ",
"state": "NI-CA",
"transfer_code": "9010001000528"
},
"type": "remittancetnusdin-ni",
"typeClass": "remittance",
"typeCountry": "NI"
},
"descriptionText": "Test",
"fees": {
"creditPartyEarnedCommission": "0.00000000",
"creditPartyNetCommission": "0.00000000",
"creditPartyPaidCommission": "0.00000000",
"debitPartyEarnedCommission": "0.00000000",
"debitPartyNetCommission": "0.00000000",
"debitPartyPaidCommission": "0.00000000"
},
"finishedDate": "2024-06-06T21:17:21.197708Z",
"fx": {},
"geoCode": "",
"metadata": [
{
"creationDate": "2024-06-06T21:17:20Z",
"key": "SV_TRANSACTION_ID",
"value": "102519"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_secondIdentificationExpirationDate",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_cityOfResidence",
"value": "HUMBLE"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_exchangeRateOriginationPayment",
"value": "1"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_settlementCurrency",
"value": "USD"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_agentId",
"value": "39208"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_dateOfTransfer",
"value": "2024-06-05"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_dateOfBirth",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_personId",
"value": "804222"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_provinceOfResidence",
"value": "TX"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_secondLastName",
"value": "RUIZ"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_paymentInfo_paymentTax",
"value": "0"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_settlementAmount",
"value": "100"
},
{
"creationDate": "2024-06-06T21:17:21Z",
"key": "authAndConfirmmessage",
"value": "Autorización y Confirmación de Pago Exitosa."
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "remittanceCurrency",
"value": "USD"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "claimNumber",
"value": "9010001000528"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_provinceOfResidence",
"value": "OTR"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_paymentInfo_amountInDollars",
"value": "100"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_originatingCurrency",
"value": "USD"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_originatingCountryCode",
"value": "USA"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "message",
"value": "Transfer Info Request Successful."
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "remittanceAmount",
"value": "100"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_address",
"value": "AVENIDA890ESQEDISON3 "
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_identificationExpirationDate",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_countryOfResidence",
"value": "USA"
},
{
"creationDate": "2024-06-06T21:17:21Z",
"key": "authorizationPaymentCode",
"value": "037566248153287439"
},
{
"creationDate": "2024-06-06T21:17:21Z",
"key": "confirmationPaymentCode",
"value": "238027932039"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "businessUnitId",
"value": "0"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_identificationExpirationDate",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_countryOfResidence",
"value": "NIC"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_dateOfBirth",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_securitySocialNumber",
"value": "0"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_telephone",
"value": "8322831523"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_personId",
"value": "804209"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_paymentType",
"value": "CASH"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_transactionType",
"value": "TRANSFER"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "returnCode",
"value": "11000"
},
{
"creationDate": "2024-06-06T21:17:21Z",
"key": "authAndConfirmdescription",
"value": "Autorización y Confirmación de Pago Exitosa."
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transferId",
"value": "375662481"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_cityOfResidence",
"value": "CORTAZAR"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_lastName",
"value": "JARA"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_firstName",
"value": "ROBERTO"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "description",
"value": "Solicitud de información atendida exitosamente."
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_lastName",
"value": "GONZALEZ"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_beneficiary_firstName",
"value": "SEBASTIAN"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_postalCode",
"value": "77338"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_address",
"value": "8455WILLCLAYTONPKWY "
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_exchangeRateSettlementPayment",
"value": "1"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_transmitterId",
"value": "64"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_locationId",
"value": "PNI368"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transmitterCode",
"value": "1"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_sender_secondIdentificationExpirationDate",
"value": "1900-01-01"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_paymentInfo_netPaymentAmount",
"value": "100"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_openTransfer",
"value": "true"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_exchangeRateOriginationSettlement",
"value": "1"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_originatingAmount",
"value": "100"
},
{
"creationDate": "2024-06-06T21:16:59Z",
"key": "transfer_info_originatingCountry",
"value": "1"
},
{
"creationDate": "2024-06-06T21:17:21Z",
"key": "authAndConfirmreturnCode",
"value": "11004"
}
],
"modificationDate": "2024-06-06T21:17:21.197708Z",
"paid": false,
"quotationId": "1002508",
"recipientKyc": {},
"requestingOrganisationTransactionReference": "",
"senderKyc": {},
"serviceCost": {
"details": [],
"totalCostInTransactionCurrency": "0.00000000",
"totalCostInUSD": "0.00000000"
},
"subType": "",
"transactionReference": "1001919",
"transactionStatus": "finished",
"transactionSubStatus": "finished",
"type": "remittance"
}'
Updated 5 months ago