Introduction

Bank payouts are processed in Argentina, Colombia, Mexico, and Peru.

Supported Countries

• Argentina
• Colombia
• Mexico
• Peru

Supported Currencies

• ARS
• COP
• MXN
• PEN
• USD

Payout (Withdrawal) Flow

When performing a /payout with LATAM Payouts, the following flow including the /accountCapture method is used before processing the /payout request:

1. Generate a sessionToken. Press here for details.
2. Send an /accountCapture request that includes the following mandatory fields as shown in the example requests below:
   • userTokenId – Unique customer identifier in merchant system.
   • paymentMethod: “apmgw_LATAM_Payouts“
   • currencyCode
   • countryCode
     
     The request returns a redirectUrl (see example responses below).
3. Use redirectUrl to redirect the customer to the APM’s account details capture interface for them to enter their account details.
4. Once the information is captured, Nuvei stores the data in a userPaymentOptionId (UPO) identifier, and sends a  back to you with the newly created userPaymentOptionId.
5. Send a /payout request and include the userPaymentOptionId, which contains the user’s previously stored APM account details. Press here for an example.

User Experience

1. The user is redirected to an account capture page, which changes depending on your country.
2. The user enters the necessary bank details for the relevant country (see below) and presses Confirm.
   A payout request is created​.

Argentina

Colombia

Mexico

Peru

Test Data

Argentina

Beneficiary Name: Juan Doe
Account Type: Current Account
Account Number: 0720781324000000541234
Account Identification Type: Single Tax Identification
Account Identification: 20261234516
State: BUENOS AIRES
Street: My street

Colombia

Beneficiary Name: Juan Doe
Account Type: Current Account
Account Number: 12312312300
Bank: BANCO DAVIVIENDA S.A.
Account Identification Type: Nit
Account Identification: 123123123

Mexico

Beneficiary Name: Juan Doe
Account Number: 012180001780500588

Peru

Beneficiary Name: Juan Doe
Account Number: 00110241760299983030
Account Identification Type: RUC
Account Identification: 20467675436

Appendix

This appendix presents sets of example  /accountCapture requests/responses according to country.

Argentina

Example /accountCapture Request

{
  "sessionToken": "<sessionToken from /getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "userTokenId": "<unique customer identifier in merchant system>",
  "paymentMethod": "apmgw_LATAM_Payouts",
  "currencyCode": "ARS",
  "countryCode": "AR"
}

Example /accountCapture Response

{
  "redirectUrl":"https://apmtest.gate2shop.com/ppp/resources/cdn/v1/bank-details-58820.html?submitUrl=https%3A%2F%2Fjumpbox.safecharge.com%2Fdmz%2FApmConnector%2FbankCapture%2F029B3614759546B0C7F6797BA3E1EE3B&country=AR&locale=en_AR",
  "userTokenId":"11234LATAM_Payouts_ARS",
  "sessionToken":"de2fced5-2faf-4b7d-bd38-5f39445df1d1",
  "internalRequestId":20699871,
  "status":"SUCCESS",
  "errCode":0,
  "reason":"",
  "merchantId":"5416795427517477813",
  "merchantSiteId":"186111",
  "version":"1.0"
}

Colombia

Example /accountCapture Request

{
  "sessionToken": "<sessionToken from /getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "userTokenId": "<unique customer identifier in merchant system>",
  "paymentMethod": "apmgw_LATAM_Payouts",
  "currencyCode": "COP",
  "countryCode": "CO"
}

Example /accountCapture Response

{
  "redirectUrl":"https://apmtest.gate2shop.com/ppp/resources/cdn/v1/bank-details-58820.html?submitUrl=https%3A%2F%2Fjumpbox.safecharge.com%2Fdmz%2FApmConnector%2FbankCapture%2F900D90F01EACA421E20181CE6D8433C7&country=CO&locale=en_CO",
  "userTokenId":"11123LATAM_Payouts_COP",
  "sessionToken":"b47ee430-e93f-4e66-87e3-f8e80bc11784",
  "internalRequestId":20699761,
  "status":"SUCCESS",
  "errCode":0,
  "reason":"",
  "merchantId":"5416795427517477813",
  "merchantSiteId":"186111",
  "version":"1.0"
}

Mexico

Example /accountCapture Request

{
  "sessionToken": "<sessionToken from /getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "userTokenId": "<unique customer identifier in merchant system>",
  "paymentMethod": "apmgw_LATAM_Payouts",
  "currencyCode": "MXN",
  "countryCode": "MX"
}

Example /accountCapture Response

{
  "redirectUrl":"https://apmtest.gate2shop.com/ppp/resources/cdn/v1/bank-details-58820.html?submitUrl=https%3A%2F%2Fjumpbox.safecharge.com%2Fdmz%2FApmConnector%2FbankCapture%2FE49E007D255327283EC73C6F7158CC03&country=MX&locale=en_MX",
  "userTokenId":"1234567LATAM_Payouts_MXN",
  "sessionToken":"33430489-8303-4373-8238-81ce98f476a9",
  "internalRequestId":20700071,
  "status":"SUCCESS",
  "errCode":0,
  "reason":"",
  "merchantId":"5416795427517477813",
  "merchantSiteId":"186111",
  "version":"1.0"
}

Peru

Example /accountCapture Request

{
  "sessionToken": "<sessionToken from /getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "userTokenId": "<unique customer identifier in merchant system>",
  "paymentMethod": "apmgw_LATAM_Payouts",
  "currencyCode": "PEN",
  "countryCode": "PE"
}

Example /accountCapture Response

{
  "redirectUrl":"https://apmtest.gate2shop.com/ppp/resources/cdn/v1/bank-details-58820.html?submitUrl=https%3A%2F%2Fjumpbox.safecharge.com%2Fdmz%2FApmConnector%2FbankCapture%2FAB8AD268E5A76247A412C5B77AB26D36&country=PE&locale=en_PE",
  "userTokenId":"123456LATAM_Payouts_PEN",
  "sessionToken":"813dda9c-9ea3-47c2-be58-81acff81063c",
  "internalRequestId":20699381,
  "status":"SUCCESS",
  "errCode":0,
  "reason":"",
  "merchantId":"5416795427517477813",
  "merchantSiteId":"186111",
  "version":"1.0"
}