Supported Transaction Types
Authorisation
Capture
Purchase
Refund
Withdrawal
Void
Integrations Supported
Deposit
Hosted Payment Page
Direct Connect ( server-to-server)
Withdrawal
Hosted Payment Page
Direct Connect ( server-to-server)
Official Logo:.png)
Currencies & Countries Supported
Title | Description |
|---|---|
Currencies Supported | Brazil, Mexico, Colombia, Chile, Peru |
Additional attributes to process Pagsmile
You must include the following JSON Attributes to the payload. These attributes inform us to redirect to Pagsmile to finalize the payment process.
Description | Hosted Payment Page | Direct Connect (Withdrawals) |
|---|---|---|
Transaction type | "TransactionType": "PURC", | "TransactionType": "ORIGINALCREDIT", |
Client | "Client": { "Email": "test@email.com", "FirstName": "John", "LastName": "Doe", "Country": "NGA", "MobileNo": "10449262289", "Street": "Street Name, 1", "City": "London", "IPAddress": "127.0.0.1" }, | "Client": { "Email": "test@email.com", "FirstName": "John", "LastName": "Doe", "Country": "NGA", "MobileNo": "10449262289", "Street": "Street Name, 1", "City": "London", "IPAddress": "127.0.0.1" }, |
Force Transaction Routing | "Routing": { "ForcePayment": "PAGSMILE" }, | |
Payment Method Data | "PaymentMethodData":{ "PaymentMethod": "lottery", "DocumentNumber": "50284414727", "DocumentType": "CPF", "ArrivalCurrency": "BRL" | |
Payment Destination | "PaymentDestination": { "PaymentMethodData": { "PayoutType": "brazil-pix", "DocumentNumber": "50284414727", "DocumentType": "CPF", "ArrivalCurrency": "BRL", "PayoutAccountType": "EMAIL" } | |
Test Indicator (required in Sandbox Environment only) | "IsTest": True | |
Sample Deposit Request
Refer to our API Reference Document here to create a Hosted Payment Page, use the below mandatory tags to process a deposit.
Below is a sample deposit request.
{
"TransactionType": "PURC",
"Amount": "2000.00",
"Currency": "BRL",
"OrderReference": "Hello World",
"RedirectionURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Redirect/",
"CallBackURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Listener",
"Language": "pt",
"Client": {
"FirstName": "Apco",
"LastName": "Test",
"Email": "Apco@Test.com",
"ClientAccount": "321",
"City": "Rio de Janeiro",
"ZIPCode": "00000",
"State": "RJ",
"Street": "Street",
"Country": "BR",
"MobileNo": "9999999",
"IPAddress": "127.0.0.0.1"
},
"PaymentMethodData":{
"PaymentMethod": "lottery",
"DocumentNumber": "50284414727",
"DocumentType": "CPF",
"ArrivalCurrency": "BRL"
},
"OrderDescription": "Test",
"Routing": {
"ForcePayment": "PAGSMILE"
},
"IsTest": "True"
}Withdrawals
Withdrawals are processed via Direct Connect. The API reference to request a payout can be found here.
Below is a sample Withdrawal request.
{
"TransactionType": "ORIGINALCREDIT",
"Amount": "200.00",
"Currency": "BRL",
"OrderReference": "MerchantOrder1",
"RedirectionURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Redirect/",
"CallBackURL": "https://api.dev.apspglobal.com/technicalsupporttool-fe/Listener",
"Routing": {
"ForcePayment": "PAGSMILE"
},
"IsTest": true,
"PaymentDestination": {
"PaymentMethodData": {
"PayoutType": "brazil-pix",
"DocumentNumber": "50284414727",
"DocumentType": "CPF",
"ArrivalCurrency": "BRL",
"PayoutAccountType": "EMAIL"
}
},
"Client": {
"FirstName": "Apco",
"LastName": "Test",
"Email": "Apco@Test.com",
"ClientAccount": "apco@test.com",
"City": "Rio de Janeiro",
"ZIPCode": "00000",
"State": "RJ",
"Street": "Street",
"Country": "BR",
"MobileNo": "9999999",
"IPAddress": "127.0.0.0.1"
}
}Functionalities - Available payment methods
Registration Country : Brazil
Registration Country : Mexico
Registration Country : Colombia
Registration Country : Chile
Registration Country : Peru