Cash Transfers
Cash Payout (Payment Code)
Auth-Service API
curl --location --request POST 'https://{{baseUrl}}/auth-service/1.1/protocol/openid-connect/token' \
--header 'x-api-key: {{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"
}
PaymentMethod API
curl --location --request GET 'https://{{baseUrl}}/payment-methods/1.0/paymentmethodtypes?direction=out&country=UY&paymentMethodTypeClass=cash&paymentMethodTypeStatus=available' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'apikey: {{api_key}}'
[
{
"country": "UY",
"currency": "UYU",
"directUsage": true,
"direction": "out",
"fields": [
{
"description": "Document number",
"fieldType": "input",
"isUserField": true,
"mandatory": true,
"name": "document_number",
"regex": ".*",
"validOptions": []
},
{
"description": "Expiration hours",
"fieldType": "input",
"isUserField": false,
"mandatory": false,
"name": "expiration_hours",
"regex": ".*",
"validOptions": []
}
],
"imageURL": null,
"paymentMethodType": "redpagosout-uy",
"paymentMethodTypeClass": "cash",
"paymentMethodTypeDescription": "RedPagos",
"paymentMethodTypePos": [],
"paymentMethodTypeStatus": "available",
"protected": false,
"storable": false,
"usage": null
}
]
Transactions API
curl --location --request POST 'https://gateway-am.apps.ins.inswhub.com/transactions/1.0/transactions/type/withdrawal' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'x-api-key: {{api_key}}' \
--header 'X-CorrelationID: 94850499-e639-4037-987f-1f56d17436eb' \
--header 'X-Callback-URL: https://webhook.site/db46c24f-b95a-4a8c-9a6a-636d6d575b21' \
--header 'X-Channel: WS' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": "150",
"currency": "UYU",
"creditParty": {
"type": "redpagosout-uy",
"data" : {
"document_number" : "12345678",
"expiration_hours" : "48"
}
},
"debitParty": {
"paymentMethodReference": "{{payment_reference}}"
},
"descriptionText": "Cash out 25/08",
"requestingOrganisationTransactionReference": "185668",
"country": "UY"
}'
{
"amount": "150.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "UY",
"creationDate": "2022-08-25T19:38:25.472136Z",
"creditParty": {
"data": {
"document_number": "12345678",
"expiration_hours": "48"
},
"type": "redpagosout-uy",
"typeClass": "cash",
"typeCountry": "UY"
},
"currency": "UYU",
"debitParty": {
"data": {
"ACCOUNT_ID": "1000503"
},
"paymentMethodReference": "3939393332332D313030302D32333438",
"type": "emoneyout-uyu",
"typeClass": "emoneyout",
"typeCountry": "UY"
},
"descriptionText": "Cash out 25/08",
"fees": {
"creditPartyEarnedCommission": "0.00000000",
"creditPartyNetCommission": "0.00000000",
"creditPartyPaidCommission": "0.00000000",
"debitPartyEarnedCommission": "0.00000000",
"debitPartyNetCommission": "0.00000000",
"debitPartyPaidCommission": "0.00000000"
},
"fx": {},
"geoCode": "",
"metadata": [
{
"creationDate": "2022-08-25T19:38:25Z",
"key": "SV_TRANSACTION_ID",
"value": "107339"
},
{
"creationDate": "2022-08-25T19:38:25Z",
"key": "DEBIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-25T19:38:25Z",
"key": "CREDIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-25T19:38:25Z",
"key": "DEBIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-25T19:38:25Z",
"key": "DEBIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-25T19:38:25Z",
"key": "CREDIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-25T19:38:25Z",
"key": "CREDIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
}
],
"modificationDate": "2022-08-25T19:38:25.655011Z",
"recipientKyc": {},
"requestDate": "",
"requestingOrganisationTransactionReference": "185668",
"requiredAction": {
"actionType": "paymentcode",
"data": {
"additionalInformation": [],
"code": "3113520394"
},
"expirationDate": "2022-08-27T19:38:25Z",
"relatedPaymentMethodData": {
"paymentMethodType": "redpagosout-uy",
"paymentMethodTypeClass": "cash",
"paymentMethodTypeCountry": "UY",
"paymentMethodTypeDescription": "RedPagos"
},
"status": "active"
},
"senderKyc": {},
"subType": "",
"transactionReference": "1005501",
"transactionStatus": "waiting",
"type": "withdrawal"
}
Callbacks
curl -X 'PUT' '{{callback_URL}}' \
--header 'connection: close' \
--header 'accept-encoding: gzip'\
--header 'x-timestamp: 2022-08-25T19:38:25.684163Z'\
--header 'x-signature: LyWKCG2JhUIju2iFzA2HF//zfgPAdpuBqCQYlAFGXfOyZQjnd+cgO1xUwLb+cCzBsmxMLjsiYVsKKO6mtoTrK1CpRhmChh+Df9hKIszLkg28G4EudupLRFUaPWY4ftwbhdZjyUMOztbNQSwGxdal9wlsOEtRVnt/RtyLVTCKnvIJjcdzemwqMUZ9k4r//y1ckZo5q+Pa9HJqq6KEto/x5rw+V66nk/U6GvlIf4gQ22UBtZjxjhxfDOiT0O7xEPtl/7aQkG2hxpx9VeVWpsGkcY3pPRd2wPQooxoIAaSFi76h0r8cQ5/gA2KOoxNpn7Nxg4yX5ZwwOk+O/Q6lG5itJg==' \
--header 'x-correlationid: d32b115e-ac24-4035-b51b-e1a8a953f00e'\
--header 'content-type: application/json'
--header 'content-length: 2035'\
--data-raw '{
"amount":"150.00000000",
"conciliationOptions":[
"finished",
"error"
],
"confirmed":true,
"country":"UY",
"creationDate":"2022-08-25T19:38:25.472136Z",
"creditParty":{
"data":{
"document_number":"12345678",
"expiration_hours":"48"
},
"type":"redpagosout-uy",
"typeClass":"cash",
"typeCountry":"UY"
},
"currency":"UYU",
"debitParty":{
"data":{
"ACCOUNT_ID":"1000503"
},
"paymentMethodReference":"3939393332332D313030302D32333438",
"type":"emoneyout-uyu",
"typeClass":"emoneyout",
"typeCountry":"UY"
},
"descriptionText":"Cash out 25/08",
"fees":{
"creditPartyEarnedCommission":"0.00000000",
"creditPartyNetCommission":"0.00000000",
"creditPartyPaidCommission":"0.00000000",
"debitPartyEarnedCommission":"0.00000000",
"debitPartyNetCommission":"0.00000000",
"debitPartyPaidCommission":"0.00000000"
},
"fx":{
},
"geoCode":"",
"metadata":[
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"SV_TRANSACTION_ID",
"value":"107339"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"DEBIT_PARTY_PAID_COMMISSION",
"value":"0.00000000"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"CREDIT_PARTY_NET_COMMISSION",
"value":"0.00000000"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"DEBIT_PARTY_EARNED_COMMISSION",
"value":"0.00000000"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"DEBIT_PARTY_NET_COMMISSION",
"value":"0.00000000"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"CREDIT_PARTY_PAID_COMMISSION",
"value":"0.00000000"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"CREDIT_PARTY_EARNED_COMMISSION",
"value":"0.00000000"
}
],
"modificationDate":"2022-08-25T19:38:25.655011Z",
"recipientKyc":{
},
"requestDate":"",
"requestingOrganisationTransactionReference":"185668",
"requiredAction":{
"actionType":"paymentcode",
"data":{
"additionalInformation":[
],
"code":"3113520394"
},
"expirationDate":"2022-08-27T19:38:25Z",
"relatedPaymentMethodData":{
"paymentMethodType":"redpagosout-uy",
"paymentMethodTypeClass":"cash",
"paymentMethodTypeCountry":"UY",
"paymentMethodTypeDescription":"RedPagos"
},
"status":"active"
},
"senderKyc":{
},
"subType":"",
"transactionReference":"1005501",
"transactionStatus":"waiting",
"type":"withdrawal"
}'
curl -X 'PUT' '{{callback_URL}}' \
--header 'connection: close' \
--header 'accept-encoding: gzip'\
--header 'x-timestamp: 2022-08-25T21:49:25.529638Z' \
--header 'x-signature: b85IqD/B5+oYh6Zl6NwWz6sy4+ict964/7qvbkkc97wXmLRHQxbUv+tyRbi4vZHH6cs3hd9QYUdKN51RFLp4EhISYxwYsng3jQOZY9bFcEhK8Ejke8tf2lU4c2slCmtzDtk5WVyFDTib8hpayy2WjV69XmYlpmUl7VLtW5dKALrvKm+EBDhih3Y5MxJTZ4ycVxv8ymJgZKmjhL/9pJRo5UgqcNF8L6V/5vaOx063SNvXw2xoP+DU38Lvo36c3PMxzkslW51nIX0goqqlL/ORHL+2DXvQu6LbDy87R0+0JM0joTEIxqpi2S98+1ZV0cwE7X8MTFUDY3P+apM97YHRdQ==' \
--header 'x-correlationid: d32b115e-ac24-4035-b51b-e1a8a953f00e'\
--header 'content-type: application/json'
--header 'content-length: 2049'\
--data-raw '{
"amount":"150.00000000",
"conciliationOptions":[
],
"confirmed":true,
"country":"UY",
"creationDate":"2022-08-25T19:38:25.472136Z",
"creditParty":{
"data":{
"document_number":"12345678",
"expiration_hours":"48"
},
"type":"redpagosout-uy",
"typeClass":"cash",
"typeCountry":"UY"
},
"currency":"UYU",
"debitParty":{
"data":{
"ACCOUNT_ID":"1000503"
},
"paymentMethodReference":"3939393332332D313030302D32333438",
"type":"emoneyout-uyu",
"typeClass":"emoneyout",
"typeCountry":"UY"
},
"descriptionText":"Cash out 25/08",
"fees":{
"creditPartyEarnedCommission":"0.00000000",
"creditPartyNetCommission":"0.00000000",
"creditPartyPaidCommission":"0.00000000",
"debitPartyEarnedCommission":"0.00000000",
"debitPartyNetCommission":"0.00000000",
"debitPartyPaidCommission":"0.00000000"
},
"fx":{
},
"geoCode":"",
"metadata":[
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"SV_TRANSACTION_ID",
"value":"107339"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"DEBIT_PARTY_PAID_COMMISSION",
"value":"0.00000000"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"CREDIT_PARTY_NET_COMMISSION",
"value":"0.00000000"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"DEBIT_PARTY_EARNED_COMMISSION",
"value":"0.00000000"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"DEBIT_PARTY_NET_COMMISSION",
"value":"0.00000000"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"CREDIT_PARTY_PAID_COMMISSION",
"value":"0.00000000"
},
{
"creationDate":"2022-08-25T19:38:25Z",
"key":"CREDIT_PARTY_EARNED_COMMISSION",
"value":"0.00000000"
}
],
"modificationDate":"2022-08-25T21:49:25.514669Z",
"recipientKyc":{
},
"requestDate":"",
"requestingOrganisationTransactionReference":"185668",
"requiredAction":{
"actionType":"paymentcode",
"data":{
"additionalInformation":[
],
"code":"3113520394"
},
"expirationDate":"2022-08-27T19:38:25Z",
"relatedPaymentMethodData":{
"paymentMethodType":"redpagosout-uy",
"paymentMethodTypeClass":"cash",
"paymentMethodTypeCountry":"UY",
"paymentMethodTypeDescription":"RedPagos"
},
"status":"confirmed"
},
"senderKyc":{
},
"subType":"",
"transactionReference":"1005501",
"transactionStatus":"finished",
"type":"withdrawal"
}'
Updated 23 days ago