Card Payments
Card Payment (using redirection)
These payment methods implement the redirecturl action to return a PCI-DSS compliant web form, hosted by Inswitch, where the customer provides the card information to complete the payment securelly.
By using this payment method, Merchants don´t require to be PCI compliant.
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"
}
Payment-Methods API
curl --location --request GET 'https://{{baseUrl}}/payment-methods/1.0/paymentmethodtypes?direction=in&country=BR&paymentMethodTypeClass=card&paymentMethodTypeStatus=available' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'apikey: {{apikey}}'
[
{
"country": "BR",
"currency": "BRL",
"directUsage": true,
"direction": "in",
"fields": [
{
"description": "Card Token",
"fieldType": "input",
"isUserField": true,
"mandatory": false,
"name": "cardToken",
"regex": ".*",
"validOptions": []
},
{
"description": "Document number",
"fieldType": "input",
"isUserField": true,
"mandatory": true,
"name": "document_number",
"regex": ".*",
"validOptions": []
},
{
"description": "First name",
"fieldType": "input",
"isUserField": true,
"mandatory": true,
"name": "first_name",
"regex": ".*",
"validOptions": []
},
{
"description": "Last name",
"fieldType": "input",
"isUserField": true,
"mandatory": true,
"name": "last_name",
"regex": ".*",
"validOptions": []
}
],
"imageURL": null,
"paymentMethodType": "cardurlin-br",
"paymentMethodTypeClass": "card",
"paymentMethodTypeDescription": "Credit Card URL",
"paymentMethodTypePos": [],
"paymentMethodTypeStatus": "available",
"protected": false,
"storable": true,
"usage": null
}
]
Transactions API
curl --location --request POST '{{baseUrl}}/transactions/1.0/transactions/type/deposit' \
--header 'apikey: {{apikey}}' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'X-CorrelationID: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'X-Redirect-OK: https://mysite.com/success' \
--header 'X-Redirect-Error: https://mysite.com/error' \
--header 'X-Redirect-Error: {{callbackUrl}}' \
--header 'X-Channel: WS' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": "12",
"currency": "BRL",
"debitParty": {
"type": "cardurlin-br",
"data": {
"document_number" :"89831500091",
"first_name": "Michel",
"last_name" : "Costa"
}
},
"creditParty": {
"paymentMethodReference": "3935303035322D313030302D31353436"
},
"descriptionText": "Card BR 1/02",
"requestingOrganisationTransactionReference": "185813",
"country": "BR"
}'
{
"amount": "12.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "BR",
"creationDate": "2022-08-29T14:22:48.035585Z",
"creditParty": {
"data": {
"ACCOUNT_ID": "1000158"
},
"paymentMethodReference": "3935303035322D313030302D31353436",
"type": "emoneyin-brl",
"typeClass": "emoneyin",
"typeCountry": "BR"
},
"currency": "BRL",
"debitParty": {
"data": {
"document_number": "89831500091",
"first_name": "Michel",
"gateway": "asaas",
"last_name": "Costa"
},
"type": "cardurlin-br",
"typeClass": "card",
"typeCountry": "BR"
},
"descriptionText": "Card BR 1/02",
"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-29T14:22:48Z",
"key": "SV_TRANSACTION_ID",
"value": "107343"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
}
],
"modificationDate": "2022-08-29T14:22:48.207674Z",
"recipientKyc": {},
"requestDate": "",
"requestingOrganisationTransactionReference": "185813",
"requiredAction": {
"actionType": "redirecturl",
"data": {
"additionalInformation": [],
"redirectURL": "https://..."
},
"expirationDate": "2023-08-24T14:22:48Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-br",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "BR",
"paymentMethodTypeDescription": "Credit Card URL"
},
"status": "active"
},
"senderKyc": {},
"subType": "",
"transactionReference": "1005505",
"transactionStatus": "waiting",
"type": "deposit"
}
Callbacks
curl --location --request PUT '{{callback_URL}}' \
--header 'x-timestamp: 2022-08-26T19:01:07.609285Z' \
--header 'x-signature: vUddkOuHWdue42gWQxPNO6ZN8h1WmfarhBK4OaUHsYlsPvOzSal08IT2zMJsmbKaOpneHEHE9Lm70d/XpIWG5VglSqA2TX2orpt/qpaIn59yzfUEoEdN8nAVVfspbLadW5VHkDlavhyuWFVPlnridWdl9rjsxg6B44to7NurpFVn4wSSCHbtBqL8IePld3N2AUg/N/7tI6Dk4nWxsB835lbXhGSztXCNozlqOBE5KQslsIWYy0ciZZ8YqHpmXPisy6v0nKA+Ke7QModCRtXtad8WhR/oz+G7cHPtHwZRGF4SCveB2lyD85WyGzCfX9TLhiAs80T51Zj033OQRr0K9Q==' \
--header 'x-correlationid: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'content-type: application/json' \
--header 'content-length: 2948' \
--data-raw '{
"amount": "12.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "BR",
"creationDate": "2022-08-29T14:22:48.035585Z",
"creditParty": {
"data": {
"ACCOUNT_ID": "1000158"
},
"paymentMethodReference": "3935303035322D313030302D31353436",
"type": "emoneyin-brl",
"typeClass": "emoneyin",
"typeCountry": "BR"
},
"currency": "BRL",
"debitParty": {
"data": {
"document_number": "89831500091",
"first_name": "Michel",
"gateway": "asaas",
"last_name": "Costa"
},
"type": "cardurlin-br",
"typeClass": "card",
"typeCountry": "BR"
},
"descriptionText": "Card BR 1/02",
"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-29T14:22:48Z",
"key": "SV_TRANSACTION_ID",
"value": "107343"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
}
],
"modificationDate": "2022-08-29T14:22:48.207674Z",
"recipientKyc": {},
"requestDate": "",
"requestingOrganisationTransactionReference": "185813",
"requiredAction": {
"actionType": "redirecturl",
"data": {
"additionalInformation": [],
"redirectURL": "https://..."
},
"expirationDate": "2023-08-24T14:22:48Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-br",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "BR",
"paymentMethodTypeDescription": "Credit Card URL"
},
"status": "active"
},
"senderKyc": {},
"subType": "",
"transactionReference": "1005505",
"transactionStatus": "waiting",
"type": "deposit"
}'
curl --location --request PUT '{{callback_URL}}' \
--header 'x-timestamp: 2022-08-26T19:01:07.609285Z' \
--header 'x-signature: vUddkOuHWdue42gWQxPNO6ZN8h1WmfarhBK4OaUHsYlsPvOzSal08IT2zMJsmbKaOpneHEHE9Lm70d/XpIWG5VglSqA2TX2orpt/qpaIn59yzfUEoEdN8nAVVfspbLadW5VHkDlavhyuWFVPlnridWdl9rjsxg6B44to7NurpFVn4wSSCHbtBqL8IePld3N2AUg/N/7tI6Dk4nWxsB835lbXhGSztXCNozlqOBE5KQslsIWYy0ciZZ8YqHpmXPisy6v0nKA+Ke7QModCRtXtad8WhR/oz+G7cHPtHwZRGF4SCveB2lyD85WyGzCfX9TLhiAs80T51Zj033OQRr0K9Q==' \
--header 'x-correlationid: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'content-type: application/json' \
--header 'content-length: 2948' \
--data-raw '{
"amount": "12.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "BR",
"creationDate": "2022-08-29T14:22:48.035585Z",
"creditParty": {
"data": {
"ACCOUNT_ID": "1000158"
},
"paymentMethodReference": "3935303035322D313030302D31353436",
"type": "emoneyin-brl",
"typeClass": "emoneyin",
"typeCountry": "BR"
},
"currency": "BRL",
"debitParty": {
"data": {
"document_number": "89831500091",
"first_name": "Michel",
"last_name": "Costa"
},
"type": "cardurlin-br",
"typeClass": "card",
"typeCountry": "BR"
},
"descriptionText": "Card BR 1/02",
"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-29T14:22:48Z",
"key": "cardPaymentId",
"value": "161"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardPaymentStatus",
"value": "SUCCESS"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardProcessId",
"value": "pay_8887191679026289"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardExpirationYear",
"value": "23"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardToken",
"value": "585533dd-f252-42de-ae94-c67967ed2b94"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardHolderName",
"value": "Michel Costa"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardExpirationMonth",
"value": "03"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardNumber",
"value": "411111XXXXXX1111"
}
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "SV_TRANSACTION_ID",
"value": "107343"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
}
],
"modificationDate": "2022-08-29T14:22:48.207674Z",
"recipientKyc": {},
"requestDate": "",
"requestingOrganisationTransactionReference": "185813",
"requiredAction": {
"actionType": "redirecturl",
"data": {
"additionalInformation": [],
"redirectURL": "https://..."
},
"expirationDate": "2023-08-24T14:22:48Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-br",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "BR",
"paymentMethodTypeDescription": "Credit Card URL"
},
"status": "confirmed"
},
"senderKyc": {},
"subType": "",
"transactionReference": "1005505",
"transactionStatus": "finished",
"type": "deposit"
}'
Card Payment (direct API)
PCI Certified Merchant can opt for a direct API integration to process a Card payment. This integration flow allows merchants to capture card information within their own channel.
As described in the process bellow, it requires integration to Cardpayment API to send Card information and complete the payment.
The sequence flow for the current process looks as follow:
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"
}
Payment-Methods API
curl --location --request GET 'https://{{baseUrl}}/payment-methods/1.0/paymentmethodtypes?paymentMethodTypeClass=card' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'apikey: {{apikey}}'
[
{
"country": "BR",
"currency": "BRL",
"directUsage": true,
"direction": "in",
"fields": [
{
"description": "Card token",
"fieldType": "input",
"isUserField": true,
"mandatory": false,
"name": "cardToken",
"regex": ".*",
"validOptions": []
},
{
"description": "Document number",
"fieldType": "input",
"isUserField": true,
"mandatory": true,
"name": "document_number",
"regex": ".*",
"validOptions": []
},
{
"description": "First name",
"fieldType": "input",
"isUserField": true,
"mandatory": true,
"name": "first_name",
"regex": ".*",
"validOptions": []
},
{
"description": "Last name",
"fieldType": "input",
"isUserField": true,
"mandatory": true,
"name": "last_name",
"regex": ".*",
"validOptions": []
}
],
"imageURL": null,
"paymentMethodType": "cardin-br",
"paymentMethodTypeClass": "card",
"paymentMethodTypeDescription": "Credit Card Direct",
"paymentMethodTypePos": [],
"paymentMethodTypeStatus": "available",
"protected": false,
"storable": true,
"usage": null
}
]
Transactions API
curl --location --request POST '{{baseUrl}}/transactions/1.0/transactions/type/deposit' \
--header 'apikey: {{apikey}}' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'X-CorrelationID: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'X-Callback-URL: {{callbackUrl}}' \
--header 'X-Channel: WS' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": "12",
"currency": "BRL",
"debitParty": {
"type": "cardurlin-br",
"data": {
"document_number" :"89831500091",
"first_name": "Michel",
"last_name" : "Costa"
}
},
"creditParty": {
"paymentMethodReference": "{{payment_reference}}"
},
"descriptionText": "Card BR 1/02",
"requestingOrganisationTransactionReference": "185813",
"country": "BR"
}
'
{
"amount": "12.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "BR",
"creationDate": "2022-08-29T15:07:42.710632Z",
"creditParty": {
"data": {
"ACCOUNT_ID": "1000158"
},
"paymentMethodReference": "3935303035322D313030302D31353436",
"type": "emoneyin-brl",
"typeClass": "emoneyin",
"typeCountry": "BR"
},
"currency": "BRL",
"debitParty": {
"data": {
"document_number": "89831500091",
"first_name": "Michel",
"gateway": "asaas",
"last_name": "Costa"
},
"type": "cardin-br",
"typeClass": "card",
"typeCountry": "BR"
},
"descriptionText": "Card BR 1/02",
"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-29T15:07:42Z",
"key": "SV_TRANSACTION_ID",
"value": "107346"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "DEBIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "CREDIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "DEBIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "DEBIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "CREDIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "CREDIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
}
],
"modificationDate": "2022-08-29T15:07:42.880982Z",
"recipientKyc": {},
"requestDate": "",
"requestingOrganisationTransactionReference": "185813",
"requiredAction": {
"actionType": "confirmationserviceurl",
"data": {
"additionalInformation": [],
"postURL": "https://..."
},
"expirationDate": "2023-08-24T15:07:42Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardin-br",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "BR",
"paymentMethodTypeDescription": "Credit Card Direct"
},
"status": "active"
},
"senderKyc": {},
"subType": "",
"transactionReference": "1005508",
"transactionStatus": "waiting",
"type": "deposit"
}
Cardpayment API
curl --location --request POST '{{postURL}}' \
--header 'Content-Type: application/json' \
--header 'apikey:{{pciapikey}}' \
--data-raw '{
"amount": {
"currency": "BRL",
"value": "12.00"
},
"metadata": [],
"cardInfo": {
"name": "Michel Costa",
"number": "4111111111111111",
"expirationMonth": "12",
"expirationYear": "29",
"cvv": "123"
}
}'
{
"paymentReference": "aliquip anim ",
"description": "et exercitation Excepteur",
"clientInfo": {
"clientReference": "Duis aliquip ",
"clientContact": "sunt velit"
},
"amount": {
"currency": "BRL",
"value": "12.00"
},
"metadata": [],
"paymentId": "59",
"status": "PROCESSING"
}
Callbacks
curl --location --request PUT '{{callback_URL}}' \
--header 'x-timestamp: 2022-08-26T19:01:07.609285Z' \
--header 'x-signature: vUddkOuHWdue42gWQxPNO6ZN8h1WmfarhBK4OaUHsYlsPvOzSal08IT2zMJsmbKaOpneHEHE9Lm70d/XpIWG5VglSqA2TX2orpt/qpaIn59yzfUEoEdN8nAVVfspbLadW5VHkDlavhyuWFVPlnridWdl9rjsxg6B44to7NurpFVn4wSSCHbtBqL8IePld3N2AUg/N/7tI6Dk4nWxsB835lbXhGSztXCNozlqOBE5KQslsIWYy0ciZZ8YqHpmXPisy6v0nKA+Ke7QModCRtXtad8WhR/oz+G7cHPtHwZRGF4SCveB2lyD85WyGzCfX9TLhiAs80T51Zj033OQRr0K9Q==' \
--header 'x-correlationid: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'content-type: application/json' \
--header 'content-length: 2948' \
--data-raw '{
"amount": "12.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "BR",
"creationDate": "2022-08-29T15:07:42.710632Z",
"creditParty": {
"data": {
"ACCOUNT_ID": "1000158"
},
"paymentMethodReference": "3935303035322D313030302D31353436",
"type": "emoneyin-brl",
"typeClass": "emoneyin",
"typeCountry": "BR"
},
"currency": "BRL",
"debitParty": {
"data": {
"document_number": "89831500091",
"first_name": "Michel",
"gateway": "asaas",
"last_name": "Costa"
},
"type": "cardin-br",
"typeClass": "card",
"typeCountry": "BR"
},
"descriptionText": "Card BR 1/02",
"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-29T15:07:42Z",
"key": "SV_TRANSACTION_ID",
"value": "107346"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "DEBIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "CREDIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "DEBIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "DEBIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "CREDIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T15:07:42Z",
"key": "CREDIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
}
],
"modificationDate": "2022-08-29T15:07:42.880982Z",
"recipientKyc": {},
"requestDate": "",
"requestingOrganisationTransactionReference": "185813",
"requiredAction": {
"actionType": "confirmationserviceurl",
"data": {
"additionalInformation": [],
"postURL": "https://..."
},
"expirationDate": "2023-08-24T15:07:42Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardin-br",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "BR",
"paymentMethodTypeDescription": "Credit Card Direct"
},
"status": "active"
},
"senderKyc": {},
"subType": "",
"transactionReference": "1005508",
"transactionStatus": "waiting",
"type": "deposit"
}'
curl --location --request PUT '{{callback_URL}}' \
--header 'x-timestamp: 2022-08-26T19:01:07.609285Z' \
--header 'x-signature: vUddkOuHWdue42gWQxPNO6ZN8h1WmfarhBK4OaUHsYlsPvOzSal08IT2zMJsmbKaOpneHEHE9Lm70d/XpIWG5VglSqA2TX2orpt/qpaIn59yzfUEoEdN8nAVVfspbLadW5VHkDlavhyuWFVPlnridWdl9rjsxg6B44to7NurpFVn4wSSCHbtBqL8IePld3N2AUg/N/7tI6Dk4nWxsB835lbXhGSztXCNozlqOBE5KQslsIWYy0ciZZ8YqHpmXPisy6v0nKA+Ke7QModCRtXtad8WhR/oz+G7cHPtHwZRGF4SCveB2lyD85WyGzCfX9TLhiAs80T51Zj033OQRr0K9Q==' \
--header 'x-correlationid: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'content-type: application/json' \
--header 'content-length: 2948' \
--data-raw '{
"amount": "12.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "BR",
"creationDate": "2022-08-29T15:07:42.710632Z",
"creditParty": {
"data": {
"ACCOUNT_ID": "1000158"
},
"paymentMethodReference": "3935303035322D313030302D31353436",
"type": "emoneyin-brl",
"typeClass": "emoneyin",
"typeCountry": "BR"
},
"currency": "BRL",
"debitParty": {
"data": {
"document_number": "89831500091",
"first_name": "Michel",
"gateway": "asaas",
"last_name": "Costa"
},
"type": "cardin-br",
"typeClass": "card",
"typeCountry": "BR"
},
"descriptionText": "Card BR 1/02",
"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-29T14:22:48Z",
"key": "cardPaymentId",
"value": "161"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardPaymentStatus",
"value": "SUCCESS"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardProcessId",
"value": "pay_8887191679026289"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardExpirationYear",
"value": "23"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardToken",
"value": "585533dd-f252-42de-ae94-c67967ed2b94"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardHolderName",
"value": "Michel Costa"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardExpirationMonth",
"value": "03"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "cardNumber",
"value": "411111XXXXXX1111"
}
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "SV_TRANSACTION_ID",
"value": "107343"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "DEBIT_PARTY_NET_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_PAID_COMMISSION",
"value": "0.00000000"
},
{
"creationDate": "2022-08-29T14:22:48Z",
"key": "CREDIT_PARTY_EARNED_COMMISSION",
"value": "0.00000000"
}
],
"modificationDate": "2022-08-29T15:07:42.880982Z",
"recipientKyc": {},
"requestDate": "",
"requestingOrganisationTransactionReference": "185813",
"requiredAction": {
"actionType": "confirmationserviceurl",
"data": {
"additionalInformation": [],
"postURL": "https://..."
},
"expirationDate": "2023-08-24T15:07:42Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardin-br",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "BR",
"paymentMethodTypeDescription": "Credit Card Direct"
},
"status": "confirmed"
},
"senderKyc": {},
"subType": "",
"transactionReference": "1005508",
"transactionStatus": "finished",
"type": "deposit"
}'
Card Payment Reversal
Reversals operation can be used to revert a card payment transaction:
- The transaction is reverted by the total amount.
- The availability of this feature may vary depending on the payment method used.
Transactions API - Reversals
curl --location --request POST '{{baseUrl}}/transactions/1.0/transactions/{transactionReference}/reversals' \
--header 'apikey: {{apikey}}' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'X-CorrelationID: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'X-Callback-URL: {{callbackUrl}}' \
--header 'X-Channel: WS' \
--header 'Content-Type: application/json' \
--data-raw '{
"descriptionText": "Revert Card Payment",
"requestingOrganisationTransactionReference": "200000"
}
'
{
"amount": "1000.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "UY",
"creationDate": "2023-10-05T20:39:57.785706Z",
"creditParty": {
"data": {
"address": "street 23 alt 10",
"city": "Montevideo",
"document_number": "101010101",
"document_type": "nationalId",
"first_name": "Juan",
"last_name": "Perez",
"phone": "12345678",
"state": "Montevideo"
},,
"type": "cardurlin-uy",
"typeClass": "card",
"typeCountry": "UY"
},
"currency": "UYU",
"debitParty": {
"data": {
"ACCOUNT_ID": "1000004"
},
"paymentMethodReference": "3937383637362D313030302D31303232",
"type": "emoneyin-uyu",
"typeClass": "emoneyin",
"typeCountry": "UY"
},
"descriptionText": "Revert Card Payment",
"fees": {
"creditPartyEarnedCommission": "0.00000000",
"creditPartyNetCommission": "0.00000000",
"creditPartyPaidCommission": "0.00000000",
"debitPartyEarnedCommission": "0.00000000",
"debitPartyNetCommission": "0.00000000",
"debitPartyPaidCommission": "0.00000000"
},
"fx": {},
"geoCode": "",
"instructions": "https://...",
"metadata": [
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardToken",
"value": "ce40da94-75c8-4487-90a6-faae3001f72d"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardExpirationMonth",
"value": "12"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "scoreResult",
"value": "1"
},
{
"creationDate": "2023-10-05T20:38:14Z",
"key": "SV_TRANSACTION_ID",
"value": "113497"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "CommercialServiceProvider",
"value": "FDUY"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "PaymentType",
"value": "CREDITCARD"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorApprovalCode",
"value": "796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorReferenceNumber",
"value": "796926796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorTraceNumber",
"value": "796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TDateFormatted",
"value": "2023.10.05 22:38:56 (CEST)"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "conciliationId",
"value": "84638245308"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "terminalId",
"value": "98000007"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TransactionResult",
"value": "APPROVED"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TransactionTime",
"value": "1696538336"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardProcessStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardPaymentId",
"value": "2722"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardHolderName",
"value": "JUAN PEREZ"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "authorizationNumber",
"value": "Y:796926:4638245308:PPXX:7969263771"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorResponseCode",
"value": "00"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TDate",
"value": "1696538336"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "Brand",
"value": "MASTERCARD"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorBatchNumber",
"value": "001"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorCCVResponse",
"value": "X"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardNumber",
"value": "516585XXXXXX0008"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "Country",
"value": "ARG"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorResponseMessage",
"value": "Function performed error-free"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardPaymentStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "AVSResponse",
"value": "PPX"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "OrderId",
"value": "2722"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorReceiptNumber",
"value": "3771"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardBrand",
"value": "mastercard"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "installments",
"value": "1"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "externalTransactionId",
"value": "84638245308"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardProcessId",
"value": "84638245308"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardExpirationYear",
"value": "29"
}
],
"modificationDate": "2023-10-05T20:39:58.029403Z",
"paid": false,
"recipientKyc": {},
"requestingOrganisationTransactionReference": "200000",
"requiredAction": {
"actionType": "awaitconfirmation",
"data": {
"additionalInformation": []
},
"expirationDate": "2024-09-29T20:39:58Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-uy",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "UY",
"paymentMethodTypeDescription": "Tarjeta de Crédito"
},
"status": "active"
},
"reverts": "221010900",
"senderKyc": {},
"subType": "",
"transactionReference": "221010901",
"transactionStatus": "waiting",
"transactionSubStatus": "waiting",
"type": "reversal"
}
Callback - Reversal transaction
curl --location --request PUT '{{callback_URL}}' \
--header 'x-timestamp: 2022-08-26T19:01:07.609285Z' \
--header 'x-signature: vUddkOuHWdue42gWQxPNO6ZN8h1WmfarhBK4OaUHsYlsPvOzSal08IT2zMJsmbKaOpneHEHE9Lm70d/XpIWG5VglSqA2TX2orpt/qpaIn59yzfUEoEdN8nAVVfspbLadW5VHkDlavhyuWFVPlnridWdl9rjsxg6B44to7NurpFVn4wSSCHbtBqL8IePld3N2AUg/N/7tI6Dk4nWxsB835lbXhGSztXCNozlqOBE5KQslsIWYy0ciZZ8YqHpmXPisy6v0nKA+Ke7QModCRtXtad8WhR/oz+G7cHPtHwZRGF4SCveB2lyD85WyGzCfX9TLhiAs80T51Zj033OQRr0K9Q==' \
--header 'x-correlationid: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'content-type: application/json' \
--header 'content-length: 2948' \
--data-raw '{
"amount": "1000.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "UY",
"creationDate": "2023-10-05T20:39:57.785706Z",
"creditParty": {
"data": {
"address": "street 23 alt 10",
"city": "Montevideo",
"document_number": "101010101",
"document_type": "nationalId",
"first_name": "Juan",
"last_name": "Perez",
"phone": "12345678",
"state": "Montevideo"
},
"type": "cardurlin-uy",
"typeClass": "card",
"typeCountry": "UY"
},
"currency": "UYU",
"debitParty": {
"data": {
"ACCOUNT_ID": "1000004"
},
"paymentMethodReference": "3937383637362D313030302D31303232",
"type": "emoneyin-uyu",
"typeClass": "emoneyin",
"typeCountry": "UY"
},
"descriptionText": "Revert Card Payment",
"fees": {
"creditPartyEarnedCommission": "0.00000000",
"creditPartyNetCommission": "0.00000000",
"creditPartyPaidCommission": "0.00000000",
"debitPartyEarnedCommission": "0.00000000",
"debitPartyNetCommission": "0.00000000",
"debitPartyPaidCommission": "0.00000000"
},
"fx": {},
"geoCode": "",
"instructions": "https://...",
"metadata": [
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardToken",
"value": "ce40da94-75c8-4487-90a6-faae3001f72d"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardExpirationMonth",
"value": "12"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "scoreResult",
"value": "1"
},
{
"creationDate": "2023-10-05T20:38:14Z",
"key": "SV_TRANSACTION_ID",
"value": "113497"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "CommercialServiceProvider",
"value": "FDUY"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "PaymentType",
"value": "CREDITCARD"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorApprovalCode",
"value": "796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorReferenceNumber",
"value": "796926796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorTraceNumber",
"value": "796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TDateFormatted",
"value": "2023.10.05 22:38:56 (CEST)"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "conciliationId",
"value": "84638245308"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "terminalId",
"value": "98000007"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TransactionResult",
"value": "APPROVED"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TransactionTime",
"value": "1696538336"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardProcessStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardPaymentId",
"value": "2722"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardHolderName",
"value": "JUAN PEREZ"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "authorizationNumber",
"value": "Y:796926:4638245308:PPXX:7969263771"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorResponseCode",
"value": "00"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TDate",
"value": "1696538336"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "Brand",
"value": "MASTERCARD"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorBatchNumber",
"value": "001"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorCCVResponse",
"value": "X"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardNumber",
"value": "516585XXXXXX0008"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "Country",
"value": "ARG"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorResponseMessage",
"value": "Function performed error-free"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardPaymentStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "AVSResponse",
"value": "PPX"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "OrderId",
"value": "2722"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorReceiptNumber",
"value": "3771"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardBrand",
"value": "mastercard"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "installments",
"value": "1"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "externalTransactionId",
"value": "84638245308"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardProcessId",
"value": "84638245308"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardExpirationYear",
"value": "29"
}
],
"modificationDate": "2023-10-05T20:39:58.029403Z",
"paid": false,
"recipientKyc": {},
"requestingOrganisationTransactionReference": "200000",
"requiredAction": {
"actionType": "awaitconfirmation",
"data": {
"additionalInformation": []
},
"expirationDate": "2024-09-29T20:39:58Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-uy",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "UY",
"paymentMethodTypeDescription": "Tarjeta de Crédito"
},
"status": "active"
},
"reverts": "221010900",
"senderKyc": {},
"subType": "",
"transactionReference": "221010901",
"transactionStatus": "waiting",
"transactionSubStatus": "waiting",
"type": "reversal"
}'
curl --location --request PUT '{{callback_URL}}' \
--header 'x-timestamp: 2022-08-26T19:01:07.609285Z' \
--header 'x-signature: vUddkOuHWdue42gWQxPNO6ZN8h1WmfarhBK4OaUHsYlsPvOzSal08IT2zMJsmbKaOpneHEHE9Lm70d/XpIWG5VglSqA2TX2orpt/qpaIn59yzfUEoEdN8nAVVfspbLadW5VHkDlavhyuWFVPlnridWdl9rjsxg6B44to7NurpFVn4wSSCHbtBqL8IePld3N2AUg/N/7tI6Dk4nWxsB835lbXhGSztXCNozlqOBE5KQslsIWYy0ciZZ8YqHpmXPisy6v0nKA+Ke7QModCRtXtad8WhR/oz+G7cHPtHwZRGF4SCveB2lyD85WyGzCfX9TLhiAs80T51Zj033OQRr0K9Q==' \
--header 'x-correlationid: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'content-type: application/json' \
--header 'content-length: 2948' \
--data-raw '{
"amount": "1000.00000000",
"conciliationOptions": [],
"confirmed": true,
"country": "UY",
"creationDate": "2023-10-05T20:39:57.785706Z",
"creditParty": {
"data": {
"address": "street 23 alt 10",
"city": "Montevideo",
"document_number": "101010101",
"document_type": "nationalId",
"first_name": "Juan",
"last_name": "Perez",
"phone": "12345678",
"state": "Montevideo"
},
"type": "cardurlin-uy",
"typeClass": "card",
"typeCountry": "UY"
},
"currency": "UYU",
"debitParty": {
"data": {
"ACCOUNT_ID": "1000004"
},
"paymentMethodReference": "3937383637362D313030302D31303232",
"type": "emoneyin-uyu",
"typeClass": "emoneyin",
"typeCountry": "UY"
},
"descriptionText": "Revert Card Payment",
"fees": {
"creditPartyEarnedCommission": "0.00000000",
"creditPartyNetCommission": "0.00000000",
"creditPartyPaidCommission": "0.00000000",
"debitPartyEarnedCommission": "0.00000000",
"debitPartyNetCommission": "0.00000000",
"debitPartyPaidCommission": "0.00000000"
},
"fx": {},
"geoCode": "",
"metadata": [
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardToken",
"value": "ce40da94-75c8-4487-90a6-faae3001f72d"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardExpirationMonth",
"value": "12"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "scoreResult",
"value": "1"
},
{
"creationDate": "2023-10-05T20:39:59Z",
"key": "SV_TRANSACTION_ID",
"value": "113498"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "CommercialServiceProvider",
"value": "FDUY"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "PaymentType",
"value": "CREDITCARD"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorApprovalCode",
"value": "796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorReferenceNumber",
"value": "796926796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorTraceNumber",
"value": "796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TDateFormatted",
"value": "2023.10.05 22:38:56 (CEST)"
},
{
"creationDate": "2023-10-05T20:39:59Z",
"key": "card_brand",
"value": "mastercard"
},
{
"creationDate": "2023-10-05T20:39:59Z",
"key": "conciliationId",
"value": "QXYv6HmS._.28566"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "terminalId",
"value": "98000007"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TransactionResult",
"value": "APPROVED"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TransactionTime",
"value": "1696538336"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardProcessStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T20:39:59Z",
"key": "cardPaymentId",
"value": "2723"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardHolderName",
"value": "JUAN PEREZ"
},
{
"creationDate": "2023-10-05T20:39:59Z",
"key": "authorizationNumber",
"value": "2722"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorResponseCode",
"value": "00"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TDate",
"value": "1696538336"
},
{
"creationDate": "2023-10-05T20:39:59Z",
"key": "SV_TRANSACTION_ID",
"value": "113497"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "Brand",
"value": "MASTERCARD"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorBatchNumber",
"value": "001"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorCCVResponse",
"value": "X"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardNumber",
"value": "516585XXXXXX0008"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "Country",
"value": "ARG"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorResponseMessage",
"value": "Function performed error-free"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardPaymentStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T20:39:59Z",
"key": "description",
"value": "Revert Card Payment"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "AVSResponse",
"value": "PPX"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "OrderId",
"value": "2722"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorReceiptNumber",
"value": "3771"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardBrand",
"value": "mastercard"
},
{
"creationDate": "2023-10-05T20:39:59Z",
"key": "transactionReference",
"value": "221010901"
},
{
"creationDate": "2023-10-05T20:39:59Z",
"key": "paymentCode",
"value": "668285660923"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "installments",
"value": "1"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "externalTransactionId",
"value": "84638245308"
},
{
"creationDate": "2023-10-05T20:39:59Z",
"key": "cardProcessId",
"value": "84638245309"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardExpirationYear",
"value": "29"
}
],
"modificationDate": "2023-10-05T20:39:59.649365Z",
"paid": false,
"recipientKyc": {},
"requestingOrganisationTransactionReference": "200000",
"requiredAction": {
"actionType": "awaitconfirmation",
"data": {
"additionalInformation": []
},
"expirationDate": "2024-09-29T20:39:58Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-uy",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "UY",
"paymentMethodTypeDescription": "Tarjeta de Crédito"
},
"status": "confirmed"
},
"reverts": "221010900",
"senderKyc": {},
"subType": "",
"transactionReference": "221010901",
"transactionStatus": "finished",
"transactionSubStatus": "finished",
"type": "reversal"
}'
Callback - Reverted transaction
curl --location --request PUT '{{callback_URL}}' \
--header 'x-timestamp: 2022-08-26T19:01:07.609285Z' \
--header 'x-signature: vUddkOuHWdue42gWQxPNO6ZN8h1WmfarhBK4OaUHsYlsPvOzSal08IT2zMJsmbKaOpneHEHE9Lm70d/XpIWG5VglSqA2TX2orpt/qpaIn59yzfUEoEdN8nAVVfspbLadW5VHkDlavhyuWFVPlnridWdl9rjsxg6B44to7NurpFVn4wSSCHbtBqL8IePld3N2AUg/N/7tI6Dk4nWxsB835lbXhGSztXCNozlqOBE5KQslsIWYy0ciZZ8YqHpmXPisy6v0nKA+Ke7QModCRtXtad8WhR/oz+G7cHPtHwZRGF4SCveB2lyD85WyGzCfX9TLhiAs80T51Zj033OQRr0K9Q==' \
--header 'x-correlationid: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'content-type: application/json' \
--header 'content-length: 2948' \
--data-raw '{
"amount": "1000.00000000",
"conciliationOptions": [],
"confirmed": true,
"country": "UY",
"creationDate": "2023-10-05T20:38:14.689081Z",
"creditParty": {
"data": {
"ACCOUNT_ID": "1000004"
},
"paymentMethodReference": "3937383637362D313030302D31303232",
"type": "emoneyin-uyu",
"typeClass": "emoneyin",
"typeCountry": "UY"
},
"currency": "UYU",
"debitParty": {
"data": {
"address": "street 23 alt 10",
"city": "Montevideo",
"document_number": "101010101",
"document_type": "nationalId",
"first_name": "Juan",
"last_name": "Perez",
"phone": "12345678",
"state": "Montevideo"
},
"type": "cardurlin-uy",
"typeClass": "card",
"typeCountry": "UY"
},
"descriptionText": "Pago Tarjeta",
"fx": {},
"geoCode": "",
"metadata": [
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardToken",
"value": "ce40da94-75c8-4487-90a6-faae3001f72d"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardExpirationMonth",
"value": "12"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "scoreResult",
"value": "1"
},
{
"creationDate": "2023-10-05T20:38:14Z",
"key": "SV_TRANSACTION_ID",
"value": "113497"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "CommercialServiceProvider",
"value": "FDUY"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "PaymentType",
"value": "CREDITCARD"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorApprovalCode",
"value": "796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorReferenceNumber",
"value": "796926796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorTraceNumber",
"value": "796926"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TDateFormatted",
"value": "2023.10.05 22:38:56 (CEST)"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "conciliationId",
"value": "84638245308"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "terminalId",
"value": "98000007"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TransactionResult",
"value": "APPROVED"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TransactionTime",
"value": "1696538336"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardProcessStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardPaymentId",
"value": "2722"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardHolderName",
"value": "JUAN PEREZ"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "authorizationNumber",
"value": "Y:796926:4638245308:PPXX:7969263771"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorResponseCode",
"value": "00"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "TDate",
"value": "1696538336"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "Brand",
"value": "MASTERCARD"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorBatchNumber",
"value": "001"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorCCVResponse",
"value": "X"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardNumber",
"value": "516585XXXXXX0008"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "Country",
"value": "ARG"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorResponseMessage",
"value": "Function performed error-free"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardPaymentStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "AVSResponse",
"value": "PPX"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "OrderId",
"value": "2722"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "ProcessorReceiptNumber",
"value": "3771"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardBrand",
"value": "mastercard"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "installments",
"value": "1"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "externalTransactionId",
"value": "84638245308"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardProcessId",
"value": "84638245308"
},
{
"creationDate": "2023-10-05T20:38:57Z",
"key": "cardExpirationYear",
"value": "29"
}
],
"modificationDate": "2023-10-05T20:39:59.651775Z",
"paid": false,
"recipientKyc": {},
"requestingOrganisationTransactionReference": "",
"requiredAction": {
"actionType": "redirecturl",
"data": {
"additionalInformation": [],
"redirectURL": "https://..."
},
"expirationDate": "2023-10-05T20:43:14Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-uy",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "UY",
"paymentMethodTypeDescription": "Tarjeta de Crédito"
},
"status": "confirmed"
},
"revertedBy": "221010901",
"senderKyc": {},
"subType": "",
"transactionReference": "221010900",
"transactionStatus": "reverted",
"transactionSubStatus": "reverted",
"type": "deposit"
}'
Card Payment Refund
Refunds operation can be used to refund a card payment transaction:
- Refunds can be requested for either a partial or the total transaction amount.
- Multiple refunds are supported as long as the original transaction amount is not exceeded.
- The availability of these features may vary depending on the payment method used.
Transactions API - Refunds
curl --location --request POST '{{baseUrl}}/transactions/1.0/transactions/{transactionReference}/refunds' \
--header 'apikey: {{apikey}}' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'X-CorrelationID: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'X-Callback-URL: {{callbackUrl}}' \
--header 'X-Channel: WS' \
--header 'Content-Type: application/json' \
--data-raw '{
"descriptionText": "refund demo",
"requestingOrganisationTransactionReference": "ref1",
"metadata": [
{
"key": "refundKey",
"value": "refundValue"
}
],
"amount": "500"
}'
{
"amount": "500.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "UY",
"creationDate": "2023-10-05T19:30:32.393807Z",
"creditParty": {
"data": {
"address": "street 23 alt 10",
"city": "Montevideo",
"document_number": "101010101",
"document_type": "nationalId",
"first_name": "Juan",
"last_name": "Perez",
"phone": "12345678",
"state": "Montevideo"
},
"type": "cardurlin-uy",
"typeClass": "card",
"typeCountry": "UY"
},
"currency": "UYU",
"debitParty": {
"data": {
"ACCOUNT_ID": "1000004",
"overdraft": "infinity"
},
"paymentMethodReference": "3937383637362D313030302D31303232",
"type": "emoneyin-uyu",
"typeClass": "emoneyin",
"typeCountry": "UY"
},
"descriptionText": "refund demo",
"fees": {
"creditPartyEarnedCommission": "0.00000000",
"creditPartyNetCommission": "0.00000000",
"creditPartyPaidCommission": "0.00000000",
"debitPartyEarnedCommission": "0.00000000",
"debitPartyNetCommission": "0.00000000",
"debitPartyPaidCommission": "0.00000000"
},
"fx": {},
"geoCode": "",
"instructions": "https://...",
"metadata": [
{
"creationDate": "2023-10-05T19:30:32Z",
"key": "refundKey",
"value": "refundValue"
},
{
"creationDate": "2023-10-05T19:30:32Z",
"key": "SV_TRANSACTION_ID",
"value": "113491"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "scoreResult",
"value": "1"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardExpirationMonth",
"value": "12"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardToken",
"value": "fc7834a6-78be-4c76-af59-2854a782b2e3"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TDateFormatted",
"value": "2023.10.05 21:29:10 (CEST)"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorTraceNumber",
"value": "793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorReferenceNumber",
"value": "793490793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorApprovalCode",
"value": "793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "PaymentType",
"value": "CREDITCARD"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "CommercialServiceProvider",
"value": "FDUY"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardHolderName",
"value": "JUAN PEREZ"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardPaymentId",
"value": "2708"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardProcessStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TransactionTime",
"value": "1696534150"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TransactionResult",
"value": "APPROVED"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "terminalId",
"value": "98000007"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "conciliationId",
"value": "84638241048"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TDate",
"value": "1696534150"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorResponseCode",
"value": "00"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "authorizationNumber",
"value": "Y:793490:4638241048:PPXX:7934903769"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardNumber",
"value": "516585XXXXXX0008"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorCCVResponse",
"value": "X"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorBatchNumber",
"value": "001"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "Brand",
"value": "MASTERCARD"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardPaymentStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorResponseMessage",
"value": "Function performed error-free"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "Country",
"value": "ARG"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardBrand",
"value": "mastercard"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorReceiptNumber",
"value": "3769"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "OrderId",
"value": "2708"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "AVSResponse",
"value": "PPX"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardExpirationYear",
"value": "29"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardProcessId",
"value": "84638241048"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "externalTransactionId",
"value": "84638241048"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "installments",
"value": "1"
}
],
"modificationDate": "2023-10-05T19:30:32.656600Z",
"paid": false,
"recipientKyc": {},
"refunds": "221010893",
"requestingOrganisationTransactionReference": "ref1",
"requiredAction": {
"actionType": "awaitconfirmation",
"data": {
"additionalInformation": []
},
"expirationDate": "2024-09-29T19:30:32Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-uy",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "UY",
"paymentMethodTypeDescription": "Tarjeta de Crédito"
},
"status": "active"
},
"senderKyc": {},
"subType": "",
"transactionReference": "221010894",
"transactionStatus": "waiting",
"transactionSubStatus": "waiting",
"type": "refund"
}
Callback - Refund transaction
curl --location --request PUT '{{callback_URL}}' \
--header 'x-timestamp: 2022-08-26T19:01:07.609285Z' \
--header 'x-signature: vUddkOuHWdue42gWQxPNO6ZN8h1WmfarhBK4OaUHsYlsPvOzSal08IT2zMJsmbKaOpneHEHE9Lm70d/XpIWG5VglSqA2TX2orpt/qpaIn59yzfUEoEdN8nAVVfspbLadW5VHkDlavhyuWFVPlnridWdl9rjsxg6B44to7NurpFVn4wSSCHbtBqL8IePld3N2AUg/N/7tI6Dk4nWxsB835lbXhGSztXCNozlqOBE5KQslsIWYy0ciZZ8YqHpmXPisy6v0nKA+Ke7QModCRtXtad8WhR/oz+G7cHPtHwZRGF4SCveB2lyD85WyGzCfX9TLhiAs80T51Zj033OQRr0K9Q==' \
--header 'x-correlationid: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'content-type: application/json' \
--header 'content-length: 2948' \
--data-raw '{
"amount": "500.00000000",
"conciliationOptions": [
"finished",
"error"
],
"confirmed": true,
"country": "UY",
"creationDate": "2023-10-05T19:30:32.393807Z",
"creditParty": {
"data": {
"address": "street 23 alt 10",
"city": "Montevideo",
"document_number": "101010101",
"document_type": "nationalId",
"first_name": "Juan",
"last_name": "Perez",
"phone": "12345678",
"state": "Montevideo"
},
"type": "cardurlin-uy",
"typeClass": "card",
"typeCountry": "UY"
},
"currency": "UYU",
"debitParty": {
"data": {
"ACCOUNT_ID": "1000004",
"overdraft": "infinity"
},
"paymentMethodReference": "3937383637362D313030302D31303232",
"type": "emoneyin-uyu",
"typeClass": "emoneyin",
"typeCountry": "UY"
},
"descriptionText": "refund demo",
"fees": {
"creditPartyEarnedCommission": "0.00000000",
"creditPartyNetCommission": "0.00000000",
"creditPartyPaidCommission": "0.00000000",
"debitPartyEarnedCommission": "0.00000000",
"debitPartyNetCommission": "0.00000000",
"debitPartyPaidCommission": "0.00000000"
},
"fx": {},
"geoCode": "",
"instructions": "https://hostedcheckout.apps.ins.inswhub.com/confirmation/eyJ0ZW5hbnRJZCI6IlFYWXY2SG1TIiwgInRyYW5zYWN0aW9uUmVmZXJlbmNlIjoiMjIxMDEwODk0IiwgIm1vZGUiOiJzYW5kYm94In0%40thSCOGNY-n1ZxMaxa_LwAeZlGmhfVWLWfkYfn1cVvJD9aobMaXVSKGU6nzCWjxIXXDhZnRUD5ARopkZhjld06BDmNui7FfpniG_X0KhvRjPlzju1Gzx7iPOsS12qqVjWTDN1q0IICSzlfK_2NdC1l2SA5_--J941ZnTQZUdUM1Zl6xo8_MH9oNU0y7f_oEjPfHRdU-uE1BGkoZazwVbC9m_3xe-y4iv_0A2cNqMJgDyyN1aJd8tUSIitGt56GV6GEmLAawyzsPjbXa_bWYlt3GqCnGEgHORgrCLPv14RPqfBcuF-uXcnKSTRoYixu6PaE4K_mF002A96W6rPeJqmhg",
"metadata": [
{
"creationDate": "2023-10-05T19:30:32Z",
"key": "refundKey",
"value": "refundValue"
},
{
"creationDate": "2023-10-05T19:30:32Z",
"key": "SV_TRANSACTION_ID",
"value": "113491"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "scoreResult",
"value": "1"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardExpirationMonth",
"value": "12"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardToken",
"value": "fc7834a6-78be-4c76-af59-2854a782b2e3"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TDateFormatted",
"value": "2023.10.05 21:29:10 (CEST)"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorTraceNumber",
"value": "793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorReferenceNumber",
"value": "793490793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorApprovalCode",
"value": "793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "PaymentType",
"value": "CREDITCARD"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "CommercialServiceProvider",
"value": "FDUY"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardHolderName",
"value": "JUAN PEREZ"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardPaymentId",
"value": "2708"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardProcessStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TransactionTime",
"value": "1696534150"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TransactionResult",
"value": "APPROVED"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "terminalId",
"value": "98000007"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "conciliationId",
"value": "84638241048"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TDate",
"value": "1696534150"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorResponseCode",
"value": "00"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "authorizationNumber",
"value": "Y:793490:4638241048:PPXX:7934903769"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardNumber",
"value": "516585XXXXXX0008"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorCCVResponse",
"value": "X"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorBatchNumber",
"value": "001"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "Brand",
"value": "MASTERCARD"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardPaymentStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorResponseMessage",
"value": "Function performed error-free"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "Country",
"value": "ARG"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardBrand",
"value": "mastercard"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorReceiptNumber",
"value": "3769"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "OrderId",
"value": "2708"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "AVSResponse",
"value": "PPX"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardExpirationYear",
"value": "29"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardProcessId",
"value": "84638241048"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "externalTransactionId",
"value": "84638241048"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "installments",
"value": "1"
}
],
"modificationDate": "2023-10-05T19:30:32.656600Z",
"paid": false,
"recipientKyc": {},
"refunds": "221010893",
"requestingOrganisationTransactionReference": "ref1",
"requiredAction": {
"actionType": "awaitconfirmation",
"data": {
"additionalInformation": []
},
"expirationDate": "2024-09-29T19:30:32Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-uy",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "UY",
"paymentMethodTypeDescription": "Tarjeta de Crédito"
},
"status": "active"
},
"senderKyc": {},
"subType": "",
"transactionReference": "221010894",
"transactionStatus": "waiting",
"transactionSubStatus": "waiting",
"type": "refund"
}'
curl --location --request PUT '{{callback_URL}}' \
--header 'x-timestamp: 2022-08-26T19:01:07.609285Z' \
--header 'x-signature: vUddkOuHWdue42gWQxPNO6ZN8h1WmfarhBK4OaUHsYlsPvOzSal08IT2zMJsmbKaOpneHEHE9Lm70d/XpIWG5VglSqA2TX2orpt/qpaIn59yzfUEoEdN8nAVVfspbLadW5VHkDlavhyuWFVPlnridWdl9rjsxg6B44to7NurpFVn4wSSCHbtBqL8IePld3N2AUg/N/7tI6Dk4nWxsB835lbXhGSztXCNozlqOBE5KQslsIWYy0ciZZ8YqHpmXPisy6v0nKA+Ke7QModCRtXtad8WhR/oz+G7cHPtHwZRGF4SCveB2lyD85WyGzCfX9TLhiAs80T51Zj033OQRr0K9Q==' \
--header 'x-correlationid: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'content-type: application/json' \
--header 'content-length: 2948' \
--data-raw '{
"amount": "500.00000000",
"conciliationOptions": [],
"confirmed": true,
"country": "UY",
"creationDate": "2023-10-05T19:30:32.393807Z",
"creditParty": {
"data": {
"address": "street 23 alt 10",
"city": "Montevideo",
"document_number": "101010101",
"document_type": "nationalId",
"first_name": "Juan",
"last_name": "Perez",
"phone": "12345678",
"state": "Montevideo"
},
"type": "cardurlin-uy",
"typeClass": "card",
"typeCountry": "UY"
},
"currency": "UYU",
"debitParty": {
"data": {
"ACCOUNT_ID": "1000004",
"overdraft": "infinity"
},
"paymentMethodReference": "3937383637362D313030302D31303232",
"type": "emoneyin-uyu",
"typeClass": "emoneyin",
"typeCountry": "UY"
},
"descriptionText": "refund demo",
"fees": {
"creditPartyEarnedCommission": "0.00000000",
"creditPartyNetCommission": "0.00000000",
"creditPartyPaidCommission": "0.00000000",
"debitPartyEarnedCommission": "0.00000000",
"debitPartyNetCommission": "0.00000000",
"debitPartyPaidCommission": "0.00000000"
},
"fx": {},
"geoCode": "",
"metadata": [
{
"creationDate": "2023-10-05T19:30:32Z",
"key": "refundKey",
"value": "refundValue"
},
{
"creationDate": "2023-10-05T19:30:32Z",
"key": "SV_TRANSACTION_ID",
"value": "113491"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "scoreResult",
"value": "1"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardExpirationMonth",
"value": "12"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardToken",
"value": "fc7834a6-78be-4c76-af59-2854a782b2e3"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TDateFormatted",
"value": "2023.10.05 21:29:10 (CEST)"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorTraceNumber",
"value": "793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorReferenceNumber",
"value": "793490793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorApprovalCode",
"value": "793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "PaymentType",
"value": "CREDITCARD"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "CommercialServiceProvider",
"value": "FDUY"
},
{
"creationDate": "2023-10-05T19:30:34Z",
"key": "card_brand",
"value": "mastercard"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardHolderName",
"value": "JUAN PEREZ"
},
{
"creationDate": "2023-10-05T19:30:34Z",
"key": "cardPaymentId",
"value": "2709"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardProcessStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TransactionTime",
"value": "1696534150"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TransactionResult",
"value": "APPROVED"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "terminalId",
"value": "98000007"
},
{
"creationDate": "2023-10-05T19:30:34Z",
"key": "conciliationId",
"value": "QXYv6HmS._.28534"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TDate",
"value": "1696534150"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorResponseCode",
"value": "00"
},
{
"creationDate": "2023-10-05T19:30:34Z",
"key": "authorizationNumber",
"value": "2708"
},
{
"creationDate": "2023-10-05T19:30:34Z",
"key": "SV_TRANSACTION_ID",
"value": "113490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardNumber",
"value": "516585XXXXXX0008"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorCCVResponse",
"value": "X"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorBatchNumber",
"value": "001"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "Brand",
"value": "MASTERCARD"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardPaymentStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorResponseMessage",
"value": "Function performed error-free"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "Country",
"value": "ARG"
},
{
"creationDate": "2023-10-05T19:30:34Z",
"key": "description",
"value": "refund demo"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardBrand",
"value": "mastercard"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorReceiptNumber",
"value": "3769"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "OrderId",
"value": "2708"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "AVSResponse",
"value": "PPX"
},
{
"creationDate": "2023-10-05T19:30:34Z",
"key": "transactionReference",
"value": "221010894"
},
{
"creationDate": "2023-10-05T19:30:34Z",
"key": "paymentCode",
"value": "668285340033"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardExpirationYear",
"value": "29"
},
{
"creationDate": "2023-10-05T19:30:34Z",
"key": "cardProcessId",
"value": "84638241102"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "externalTransactionId",
"value": "84638241048"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "installments",
"value": "1"
}
],
"modificationDate": "2023-10-05T19:30:34.311896Z",
"paid": false,
"recipientKyc": {},
"refunds": "221010893",
"requestingOrganisationTransactionReference": "ref1",
"requiredAction": {
"actionType": "awaitconfirmation",
"data": {
"additionalInformation": []
},
"expirationDate": "2024-09-29T19:30:32Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-uy",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "UY",
"paymentMethodTypeDescription": "Tarjeta de Crédito"
},
"status": "confirmed"
},
"senderKyc": {},
"subType": "",
"transactionReference": "221010894",
"transactionStatus": "finished",
"transactionSubStatus": "finished",
"type": "refund"
}'
Callback - Refunded transaction
curl --location --request PUT '{{callback_URL}}' \
--header 'x-timestamp: 2022-08-26T19:01:07.609285Z' \
--header 'x-signature: vUddkOuHWdue42gWQxPNO6ZN8h1WmfarhBK4OaUHsYlsPvOzSal08IT2zMJsmbKaOpneHEHE9Lm70d/XpIWG5VglSqA2TX2orpt/qpaIn59yzfUEoEdN8nAVVfspbLadW5VHkDlavhyuWFVPlnridWdl9rjsxg6B44to7NurpFVn4wSSCHbtBqL8IePld3N2AUg/N/7tI6Dk4nWxsB835lbXhGSztXCNozlqOBE5KQslsIWYy0ciZZ8YqHpmXPisy6v0nKA+Ke7QModCRtXtad8WhR/oz+G7cHPtHwZRGF4SCveB2lyD85WyGzCfX9TLhiAs80T51Zj033OQRr0K9Q==' \
--header 'x-correlationid: e051c99b-f91d-4b2f-a08d-5fe62b744669' \
--header 'content-type: application/json' \
--header 'content-length: 2948' \
--data-raw '{
"amount": "1000.00000000",
"conciliationOptions": [],
"confirmed": true,
"country": "UY",
"creationDate": "2023-10-05T19:28:28.698418Z",
"creditParty": {
"data": {
"ACCOUNT_ID": "1000004"
},
"paymentMethodReference": "3937383637362D313030302D31303232",
"type": "emoneyin-uyu",
"typeClass": "emoneyin",
"typeCountry": "UY"
},
"currency": "UYU",
"debitParty": {
"data": {
"address": "street 23 alt 10",
"city": "Montevideo",
"document_number": "101010101",
"document_type": "nationalId",
"first_name": "Juan",
"last_name": "Perez",
"phone": "12345678",
"state": "Montevideo"
},
"type": "cardurlin-uy",
"typeClass": "card",
"typeCountry": "UY"
},
"descriptionText": "Pago Tarjeta",
"fx": {},
"geoCode": "",
"metadata": [
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardToken",
"value": "fc7834a6-78be-4c76-af59-2854a782b2e3"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardExpirationMonth",
"value": "12"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "scoreResult",
"value": "1"
},
{
"creationDate": "2023-10-05T19:28:28Z",
"key": "SV_TRANSACTION_ID",
"value": "113490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "CommercialServiceProvider",
"value": "FDUY"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "PaymentType",
"value": "CREDITCARD"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorApprovalCode",
"value": "793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorReferenceNumber",
"value": "793490793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorTraceNumber",
"value": "793490"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TDateFormatted",
"value": "2023.10.05 21:29:10 (CEST)"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "conciliationId",
"value": "84638241048"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "terminalId",
"value": "98000007"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TransactionResult",
"value": "APPROVED"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TransactionTime",
"value": "1696534150"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardProcessStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardPaymentId",
"value": "2708"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardHolderName",
"value": "JUAN PEREZ"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "authorizationNumber",
"value": "Y:793490:4638241048:PPXX:7934903769"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorResponseCode",
"value": "00"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "TDate",
"value": "1696534150"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "Brand",
"value": "MASTERCARD"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorBatchNumber",
"value": "001"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorCCVResponse",
"value": "X"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardNumber",
"value": "516585XXXXXX0008"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "Country",
"value": "ARG"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorResponseMessage",
"value": "Function performed error-free"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardPaymentStatus",
"value": "SUCCESS"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "AVSResponse",
"value": "PPX"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "OrderId",
"value": "2708"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "ProcessorReceiptNumber",
"value": "3769"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardBrand",
"value": "mastercard"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "installments",
"value": "1"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "externalTransactionId",
"value": "84638241048"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardProcessId",
"value": "84638241048"
},
{
"creationDate": "2023-10-05T19:29:10Z",
"key": "cardExpirationYear",
"value": "29"
}
],
"modificationDate": "2023-10-05T19:30:34.314902Z",
"paid": false,
"recipientKyc": {},
"refundedAmount": "500.00000000",
"refundedBy": [
"221010894"
],
"requestingOrganisationTransactionReference": "",
"requiredAction": {
"actionType": "redirecturl",
"data": {
"additionalInformation": [],
"redirectURL": "https://..."
},
"expirationDate": "2023-10-05T19:33:28Z",
"relatedPaymentMethodData": {
"paymentMethodType": "cardurlin-uy",
"paymentMethodTypeClass": "card",
"paymentMethodTypeCountry": "UY",
"paymentMethodTypeDescription": "Tarjeta de Crédito"
},
"status": "confirmed"
},
"senderKyc": {},
"subType": "",
"transactionReference": "221010893",
"transactionStatus": "finished",
"transactionSubStatus": "finishedWithRefunds",
"type": "deposit"
}'
Updated 23 days ago