APM payouts
Last modified: 31 March 2025APM payout example for India, INR (27001)
Request example
{
"name": "John Doe",
"amount": 500,
"accountId": "test@test.com",
"currency": "INR",
"invoiceId": "INV123",
"description": "INR API Request",
"data": {
"personId": "P123",
"phone": "123-456-7890",
"ifsc": "SBIN0000000",
"bankAccountNumber": "123456789",
"paymentTypeId": 27001
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.phone*
string
Recipient's phone number.
data.ifsc*
string
Bank IFSC code.
data.bankAccountNumber*
string
Recipient's bank account number.
data.paymentTypeId*
number
Payment type identifier.
Responses
200{...}
APM payout example for Malaysia, MYR (29004)
Request example
{
"name": "John Doe",
"amount": 100.50,
"accountId": "test@test.com",
"currency": "MYR",
"invoiceId": "INV123456",
"description": "Payout for services rendered",
"data": {
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"bankAccountNumber": "123456789012",
"bankAccountBranchCode": "123456",
"paymentTypeId": 29004
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.recipientNickName
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of account.
data.paymentTypeId*
number
Payment type identifier.
Responses
200{...}
APM payout example for Singapore, SGD (23039)
Request example
{
"name": "John Doe",
"amount": 100.50,
"accountId": "test@test.com",
"currency": "SGD",
"invoiceId": "INV123456",
"description": "Payout for services rendered",
"data": {
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"bankAccountNumber": "123456789012",
"bankAccountBranchCode": "123456",
"paymentTypeId": 23039
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.recipientNickName
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of account.
data.paymentTypeId*
number
Payment type identifier.
Responses
200{...}
APM payout example for India, INR, UPI QR (3020)
Request example
{
"name": "JOHN DOU",
"amount": 55.67,
"accountId": "88666@exemple",
"currency": "INR",
"invoiceId": "invoice-payout-test-124",
"description": "test Buckzy APM Payout",
"data": {
"personId": "22628",
"countryCode": "IN",
"paymentTypeId": 3020
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.countryCode*
string
Country code.
data.paymentTypeId*
number
Payment type identifier.
Responses
200{...}
APM payout example for Japan, JPY (29014)
Request example
{
"name": "John Doe",
"amount": 100.50,
"accountId": "test@test.com",
"currency": "JPY",
"invoiceId": "INV123456",
"description": "Payout for services rendered",
"data": {
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"bankAccountNumber": "123456789012",
"bankAccountBranchCode": "123456",
"paymentTypeId": 29014
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.recipientNickName
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of account.
data.paymentTypeId*
number
Payment type identifier.
Responses
200{...}
APM payout example for India, INR, UPI (2000)
Request example
{
"name": "John Doe",
"amount": 1.50,
"accountId": "test@test.com",
"currency": "INR",
"invoiceId": "INV123456",
"description": "test",
"data": {
"personId": "1234567890",
"phone": "380123456789",
"address": "1234 Main St",
"city": "Anytown",
"firstName": "John",
"lastName": "Doe",
"countryCode": "US",
"paymentTypeId": 2000
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.firstName*
string
Recipient's first name.
data.lastName*
string
Recipient's last name.
data.countryCode*
string
Country code.
data.paymentTypeId*
number
Payment type identifier.
Responses
200{...}
APM payout example for Brazil, BRL, PIX (26000)
Request example
{
"name": "John Doe",
"amount": 1.50,
"accountId": "test@gmail.com",
"currency": "BRL",
"invoiceId": "fJxEYRzm01boZiurSLOY6ZLvfJxEYRzm01boZiurSLOY6ZLv",
"description": "sale",
"successUrl": "https://widget.paygames.net/3ds/success",
"failureUrl": "https://widget.paygames.net/3ds/failure",
"pendingUrl": "https://widget.paygames.net/3ds/failure",
"cancelUrl": "https://widget.paygames.net/3ds/failure",
"locale": "UA",
"ip": "92.253.212.180",
"data": {
"paymentTypeId": 26000
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
successUrl*
string
URL for successful payout.
failureUrl*
string
URL for failed payout.
pendingUrl*
string
URL for pending payout.
cancelUrl*
string
URL for cancelled payout.
locale*
string
Locale for payout form.
ip*
string
Payer's IP address.
data
object
Additional payment data.
data.phone*
string
Payer's phone number.
data.address*
string
Payer's address.
data.city*
string
Payer's city.
data.state*
string
Payer's state.
data.firstName*
string
Payer's first name.
data.lastName*
string
Payer's last name.
data.countryCode*
string
Payer's country code.
data.postcode*
string
Payer's postcode.
data.paymentTypeId*
number
Payment type identifier.
Responses
200{...}
APM payout example for Thailand, THB, Bank transfer (29001)
Request example
{
"name": "John Doe",
"amount": 10000,
"accountId": "ACC123456789",
"currency": "THB",
"invoiceId": "INV123456789",
"description": "Payout for services rendered",
"data": {
"personId": "PID123456789",
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"zipCode": "12345",
"countryCode": "US",
"birthDate": "1980-01-01",
"cardExpiryMonth": 12,
"cardExpiryYear": 2023,
"paymentTypeId": 29001,
"ifsc": "IFSC0001234",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"documentType": "passport",
"document": "AB1234567",
"bankChannel": "online",
"bankAccountNumber": "1234567890123456",
"bankAccountType": "savings",
"bankAccountBranchCode": "000123"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.zipCode*
string
Recipient's postal code.
data.countryCode*
string
Country code.
data.birthDate*
string
Recipient's birth date.
data.cardExpiryMonth*
number
Expiry month of the card.
data.cardExpiryYear*
number
Expiry year of the card.
data.paymentTypeId*
number
Payment type identifier.
data.ifsc*
string
Bank IFSC code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientNickName*
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankChannel*
string
Bank channel.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountType*
string
Type of bank account.
data.bankAccountBranchCode*
string
Branch code of the account.
Responses
200{...}
APM payout example for Thailand, THB, QR payment (29002)
Request example
{
"name": "John Doe",
"amount": 10000,
"accountId": "ACC123456789",
"currency": "THB",
"invoiceId": "INV123456789",
"description": "Payout for services rendered",
"data": {
"personId": "PID123456789",
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"zipCode": "12345",
"countryCode": "US",
"birthDate": "1980-01-01",
"cardExpiryMonth": 12,
"cardExpiryYear": 2023,
"paymentTypeId": 29002,
"ifsc": "IFSC0001234",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"documentType": "passport",
"document": "AB1234567",
"bankChannel": "online",
"bankAccountNumber": "1234567890123456",
"bankAccountType": "savings",
"bankAccountBranchCode": "000123"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.zipCode*
string
Recipient's postal code.
data.countryCode*
string
Country code.
data.birthDate*
string
Recipient's birth date.
data.cardExpiryMonth*
number
Expiry month of the card.
data.cardExpiryYear*
number
Expiry year of the card.
data.paymentTypeId*
number
Payment type identifier.
data.ifsc*
string
Bank IFSC code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientNickName*
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankChannel*
string
Bank channel.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountType*
string
Type of bank account.
data.bankAccountBranchCode*
string
Branch code of the account.
Responses
200{...}
APM payout example for Thailand, THB, E-wallet (29003)
Request example
{
"name": "John Doe",
"amount": 10000,
"accountId": "ACC123456789",
"currency": "THB",
"invoiceId": "INV123456789",
"description": "Payout for services rendered",
"data": {
"personId": "PID123456789",
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"zipCode": "12345",
"countryCode": "US",
"birthDate": "1980-01-01",
"cardExpiryMonth": 12,
"cardExpiryYear": 2023,
"paymentTypeId": 29003,
"ifsc": "IFSC0001234",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"documentType": "passport",
"document": "AB1234567",
"bankChannel": "online",
"bankAccountNumber": "1234567890123456",
"bankAccountType": "savings",
"bankAccountBranchCode": "000123"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.zipCode*
string
Recipient's postal code.
data.countryCode*
string
Country code.
data.birthDate*
string
Recipient's birth date.
data.cardExpiryMonth*
number
Expiry month of the card.
data.cardExpiryYear*
number
Expiry year of the card.
data.paymentTypeId*
number
Payment type identifier.
data.ifsc*
string
Bank IFSC code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientNickName*
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankChannel*
string
Bank channel.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountType*
string
Type of bank account.
data.bankAccountBranchCode*
string
Branch code of the account.
Responses
200{...}
APM payout example for Vietnam, VND (29005)
Request example
{
"name": "John Doe",
"amount": 10000,
"accountId": "ACC123456789",
"currency": "VND",
"invoiceId": "INV123456789",
"description": "Payout for services rendered",
"data": {
"personId": "PID123456789",
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"zipCode": "12345",
"countryCode": "US",
"birthDate": "1980-01-01",
"cardExpiryMonth": 12,
"cardExpiryYear": 2023,
"paymentTypeId": 29005,
"ifsc": "IFSC0001234",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"documentType": "passport",
"document": "AB1234567",
"bankChannel": "online",
"bankAccountNumber": "1234567890123456",
"bankAccountType": "savings",
"bankAccountBranchCode": "000123"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.zipCode*
string
Recipient's postal code.
data.countryCode*
string
Country code.
data.birthDate*
string
Recipient's birth date.
data.cardExpiryMonth*
number
Expiry month of the card.
data.cardExpiryYear*
number
Expiry year of the card.
data.paymentTypeId*
number
Payment type identifier.
data.ifsc*
string
Bank IFSC code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientNickName*
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankChannel*
string
Bank channel.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountType*
string
Type of bank account.
data.bankAccountBranchCode*
string
Branch code of the account.
Responses
200{...}
APM payout example for Indonesia, IDR (29000)
Request example
{
"name": "John Doe",
"amount": 10000,
"accountId": "ACC123456789",
"currency": "IDR",
"invoiceId": "INV123456789",
"description": "Payout for services rendered",
"data": {
"personId": "PID123456789",
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"zipCode": "12345",
"countryCode": "US",
"birthDate": "1980-01-01",
"cardExpiryMonth": 12,
"cardExpiryYear": 2023,
"paymentTypeId": 29000,
"ifsc": "IFSC0001234",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"documentType": "passport",
"document": "AB1234567",
"bankChannel": "online",
"bankAccountNumber": "1234567890123456",
"bankAccountType": "savings",
"bankAccountBranchCode": "000123"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.zipCode*
string
Recipient's postal code.
data.countryCode*
string
Country code.
data.birthDate*
string
Recipient's birth date.
data.cardExpiryMonth*
number
Expiry month of the card.
data.cardExpiryYear*
number
Expiry year of the card.
data.paymentTypeId*
number
Payment type identifier.
data.ifsc*
string
Bank IFSC code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientNickName*
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankChannel*
string
Bank channel.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountType*
string
Type of bank account.
data.bankAccountBranchCode*
string
Branch code of the account.
Responses
200{...}
APM payout example for Peru, PEN, Tambo Cash (24046)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 24046,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Western Union Cash (24047)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 24047,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Kasnet Cash (24055)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 24055,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Pago Efectivo Cash (32060)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32060,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, BBVA Continental Online (32086)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32086,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Interbank Online (32087)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32087,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Scotiabank Online (32088)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32088,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Caja Huancayo Online (32089)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32089,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Caja Arequipa Online (32090)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32090,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Caja Tacna Online (32091)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32091,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Caja Trujillo Online (32092)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32092,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Banco de Crédito Online (32095)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32095,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Banco de Crédito Cash (32096)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32096,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, BBVA Continental Cash (32097)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32097,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Scotiabank Cash (32098)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32098,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Caja Huancayo Cash (32099)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32099,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Caja Arequipa Cash (32100)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32100,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Caja Tacna Cash (32101)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32101,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Caja Trujillo Cash (32102)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32102,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Banco Ripley Cash (32103)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32103,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Peru, PEN, Khipu Online (32113)
Request example
{
"name": "John Doe",
"amount": 114.31,
"accountId": "ACC123456789",
"currency": "PEN",
"invoiceId": "INV123456789",
"description": "7",
"data": {
"paymentTypeId": 32113,
"phone": "+769483848",
"address": "123 Main Street",
"city": "Anytown",
"countryCode": "PE",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientEmail": "john.doe@gmail.com",
"documentType": "02",
"document": "AB5769385865749068",
"bankAccountNumber": "001106660100012345",
"bankAccountBranchCode": "0002",
"bankName": "0002"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.paymentTypeId*
number
Payment type identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.countryCode*
string
Country code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
data.bankName*
string
Bank name code.
Responses
200{...}
APM payout example for Philippines, PHP, G Cash (29011)
Request example
{
"name": "John Doe",
"amount": 10000,
"accountId": "ACC123456789",
"currency": "PHP",
"invoiceId": "INV123456789",
"description": "Payout for services rendered",
"data": {
"personId": "PID123456789",
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"zipCode": "12345",
"countryCode": "US",
"birthDate": "1980-01-01",
"cardExpiryMonth": 12,
"cardExpiryYear": 2023,
"paymentTypeId": 29001,
"ifsc": "IFSC0001234",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"documentType": "passport",
"document": "AB1234567",
"bankChannel": "online",
"bankAccountNumber": "1234567890123456",
"bankAccountType": "savings",
"bankAccountBranchCode": "000123"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.zipCode*
string
Recipient's postal code.
data.countryCode*
string
Country code.
data.birthDate*
string
Recipient's birth date.
data.cardExpiryMonth*
number
Expiry month of the card.
data.cardExpiryYear*
number
Expiry year of the card.
data.paymentTypeId*
number
Payment type identifier.
data.ifsc*
string
Bank IFSC code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientNickName*
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankChannel*
string
Bank channel.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountType*
string
Type of bank account.
data.bankAccountBranchCode*
string
Branch code of the account.
Responses
200{...}
APM payout example for Philippines, PHP, G Cash QR (29011)
Request example
{
"name": "John Doe",
"amount": 10000,
"accountId": "ACC123456789",
"currency": "PHP",
"invoiceId": "INV123456789",
"description": "Payout for services rendered",
"data": {
"personId": "PID123456789",
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"zipCode": "12345",
"countryCode": "US",
"birthDate": "1980-01-01",
"cardExpiryMonth": 12,
"cardExpiryYear": 2023,
"paymentTypeId": 29001,
"ifsc": "IFSC0001234",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"documentType": "passport",
"document": "AB1234567",
"bankChannel": "online",
"bankAccountNumber": "1234567890123456",
"bankAccountType": "savings",
"bankAccountBranchCode": "000123"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.zipCode*
string
Recipient's postal code.
data.countryCode*
string
Country code.
data.birthDate*
string
Recipient's birth date.
data.cardExpiryMonth*
number
Expiry month of the card.
data.cardExpiryYear*
number
Expiry year of the card.
data.paymentTypeId*
number
Payment type identifier.
data.ifsc*
string
Bank IFSC code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientNickName*
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankChannel*
string
Bank channel.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountType*
string
Type of bank account.
data.bankAccountBranchCode*
string
Branch code of the account.
Responses
200{...}
APM payout example for Philippines, PHP (29011)
Request example
{
"name": "John Doe",
"amount": 10000,
"accountId": "ACC123456789",
"currency": "PHP",
"invoiceId": "INV123456789",
"description": "Payout for services rendered",
"data": {
"personId": "PID123456789",
"phone": "+1234567890",
"address": "123 Main Street",
"city": "Anytown",
"state": "Anystate",
"zipCode": "12345",
"countryCode": "US",
"birthDate": "1980-01-01",
"cardExpiryMonth": 12,
"cardExpiryYear": 2023,
"paymentTypeId": 29001,
"ifsc": "IFSC0001234",
"recipientFirstName": "John",
"recipientLastName": "Doe",
"recipientNickName": "Johnny",
"recipientEmail": "john.doe@example.com",
"documentType": "passport",
"document": "AB1234567",
"bankChannel": "online",
"bankAccountNumber": "1234567890123456",
"bankAccountType": "savings",
"bankAccountBranchCode": "000123"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.phone*
string
Recipient's phone number.
data.address*
string
Recipient's address.
data.city*
string
Recipient's city.
data.state*
string
Recipient's state.
data.zipCode*
string
Recipient's postal code.
data.countryCode*
string
Country code.
data.birthDate*
string
Recipient's birth date.
data.cardExpiryMonth*
number
Expiry month of the card.
data.cardExpiryYear*
number
Expiry year of the card.
data.paymentTypeId*
number
Payment type identifier.
data.ifsc*
string
Bank IFSC code.
data.recipientFirstName*
string
Recipient's first name.
data.recipientLastName*
string
Recipient's last name.
data.recipientNickName*
string
Recipient's nickname.
data.recipientEmail*
string
Recipient's email address.
data.documentType*
string
Type of document.
data.document*
string
Document identifier.
data.bankChannel*
string
Bank channel.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountType*
string
Type of bank account.
data.bankAccountBranchCode*
string
Branch code of the account.
Responses
200{...}
APM payout example for South Korea, KRW, Virtual account (29013)
Request example
{
"name": "John Doe",
"amount": 10000,
"accountId": "ACC123456789",
"currency": "KRW",
"invoiceId": "INV123456789",
"description": "Payout for services rendered",
"data": {
"personId": "PID123456789",
"paymentTypeId": 29013,
"document": "AB1234567",
"bankChannel": "online",
"bankAccountNumber": "1234567890123456",
"bankAccountBranchCode": "000123"
}
}POST https://api-back.paygames.net/payments/apm/payout
- Payout to account
Payout method when the funds are transferred to the specified bank account.
Parameters
Header
Header
Type
Description
Authorization
string
HTTP Basic authentication.
Content-Type
string
application/json.
Body
Parameter
Type
Description
name*
string
Recipient's name.
amount*
number
Payout amount.
currency*
string
Payout currency.
accountId*
string
Recipient's account identifier.
invoiceId
string
Order or invoice number.
description*
string
Payment description.
data
object
Additional payment data.
data.personId*
string
Person's identifier.
data.paymentTypeId*
number
Payment type identifier.
data.document*
string
Document identifier.
data.bankChannel*
string
Bank channel.
data.bankAccountNumber*
string
Recipient's bank account number.
data.bankAccountBranchCode*
string
Branch code of the account.
Responses
200{...}