PayGames API

PayGames payment gateway integration API documentation

Terms and definitions

System — PayGames payment gateway.
Merchant — PayGames client who works with the System.
API — application program interface for interacting with the system, located at https://api-back.paygames.net.
Back Office — merchant's back office in the system, located at https://dashboard.paygames.net.
Card — a bank card of Visa, MasterCard.
Acquirer — a settlement bank.
Issuer — a bank that issued a card.
Cardholder — an owner of a card issued by a bank.
Widget — payment form, provided by the system to enter card data by a holder and perform a further authorization.
3-D Secure — protocol to verify a holder by the issuer.

Transaction types

The system involves three types of operations: payment, refund, and payout. In the first case, money is transferred from holder's account to the merchant, in the second - vice versa. A merchant performs a refund if a buyer wants to return goods, and it is always associated with a payment transaction, which amount returns to a holder. It is possible to refund a whole payment amount or it's part only. Money usually comes back to a holder’s card the same day, but sometimes (it depends on an issuer) it can take up to 3 days. Payout operation is used to transfer the funds from the merchant account to the Cardholder's account. The payout is possible only when the initial payment with a Card was done using the System.

Payment methods

Via payment form — widget. Add a script that opens a secure payment form (iframe) to enter card data.
Via API by a card’s cryptogram. Add a checkout to your web site which collects card data from any web site’s form, encrypts and creates a cryptogram for a secured transmission through an interserver interaction.
Via redirect. User gets redirect to a payment page hosted on our servers.

3-D Secure

3-D Secure is a common name of Verified By Visa and MasterCard Secure Code programs from Visa and MasterCard's respectively. In general, such program shall authenticate a cardholder (that is to protect against an unauthorized card usage) by an issuer before a payment. Actually, it looks as follows: a cardholder specifies card data. Then the issuer’s web site opens, where a cardholder has to enter a password or a secret code (usually, the code is sent in a SMS message). If the code is correct, a payment will be successful. Otherwise, it will be rejected.

During the payment process, 3-D Secure appears not on all cards, but only on those, Issuers supporting this technology. Certainly, payments without 3-D Secure are a less secure option.

Payment via redirect

In Payment Redirect method the user gets redirected to the payment page, hosted by the System. Alternatively, users can follow the checkout URL to access the System's hosted page. After the user has entered his/her bank card data, the user then gets redirected back to the merchant site.

The Payment Redirect link is located in the Back Office and can be used in the following way:

GET https://api-back.paygames.net/payments/redirect/pbid_2kajhh9oqhmpwjqgd529rg?
    \ amount=10.50&
	\ description=Payment&
	\ currency=EUR&
	\ invoiceId=0001&
	\ accountId=account%40example.com&
	\ successUrl=https%3A%2F%2Fwww.example.com%2Fsuccess&
	\ failureUrl=https%3A%2F%2Fwww.example.com%2Ffailure&
	\ pendingUrl=https%3A%2F%2Fwww.example.com%2Fpending&
	\ cancelUrl=https%3A%2F%2Fwww.example.com%2Fcancel&
	\ locale=en_US

POST https://api-back.paygames.net/payments/redirect/pbid_2kajhh9oqhmpwjqgd529rg?
	\ amount=10.50&
	\ description=Payment&
	\ currency=EUR&
	\ invoiceId=0001&
	\ accountId=account%40example.com&
	\ successUrl=https%3A%2F%2Fwww.example.com%2Fsuccess&
	\ failureUrl=https%3A%2F%2Fwww.example.com%2Ffailure&
	\ pendingUrl=https%3A%2F%2Fwww.example.com%2Fpending&
	\ cancelUrl=https%3A%2F%2Fwww.example.com%2Fcancel&
	\ locale=en_US

Body:
{
"userReferenceId": "user123",
"phone": "+1234567890",
"email": "user@example.com",
"address": "123 Main St",
"city": "Cityville",
"firstName": "John",
"lastName": "Doe",
"countryCode": "UA",
"postcode": "12345",
"state": "Stateville",
"birthDate": "1990-01-01"
}

GET https://api-back.paygames.net/payments/payment-link/pbid_2kajhh9oqhmpwjqgd529rg?
	\ amount=10.50&
	\ description=Payment&
	\ currency=EUR&
	\ invoiceId=0001&
	\ accountId=account%40example.com&
	\ successUrl=https%3A%2F%2Fwww.example.com%2Fsuccess&
	\ failureUrl=https%3A%2F%2Fwww.example.com%2Ffailure&
	\ pendingUrl=https%3A%2F%2Fwww.example.com%2Fpending&
	\ cancelUrl=https%3A%2F%2Fwww.example.com%2Fcancel&
	\ locale=en_US

The system returns a response in JSON format which includes at least one parameter: paymentLinkUrl:

{
	"paymentLinkUrl": "https://payment.checkoutdirect.net/payment.html?publicId=pbid_2kajhh9oqhmpwjqgd529rg&amount=10.50&description=Payment&currency=EUR&invoiceId=0001&accountId=account%40example.com&successUrl=https%3A%2F%2Fwww.example.com%2Fsuccess&failureUrl=https%3A%2F%2Fwww.example.com%2Ffailure&cancelUrl=https%3A%2F%2Fwww.example.com%2Fcancel&pendingUrl=https%3A%2F%2Fwww.example.com%2Fpending&locale=en_US&token="
}

POST https://api-back.paygames.net/payments/payment-link/pbid_2kajhh9oqhmpwjqgd529rg?
	\ amount=10.50&
	\ description=Payment&
	\ currency=EUR&
	\ invoiceId=0001&
	\ accountId=account%40example.com&
	\ successUrl=https%3A%2F%2Fwww.example.com%2Fsuccess&
	\ failureUrl=https%3A%2F%2Fwww.example.com%2Ffailure&
	\ pendingUrl=https%3A%2F%2Fwww.example.com%2Fpending&
	\ cancelUrl=https%3A%2F%2Fwww.example.com%2Fcancel&
	\ locale=en_US

Body:
{
"userReferenceId": "user123",
"phone": "+1234567890",
"email": "user@example.com",
"address": "123 Main St",
"city": "Cityville",
"firstName": "John",
"lastName": "Doe",
"countryCode": "UA",
"postcode": "12345",
"state": "Stateville",
"birthDate": "1990-01-01"
}

The system returns a response in JSON format which includes at least one parameter: paymentLinkUrl:

{
	"paymentLinkUrl": "https://payment.checkoutdirect.net/payment.html?publicId=pbid_2kajhh9oqhmpwjqgd529rg&amount=10.50&description=Payment&currency=EUR&invoiceId=0001&accountId=account%40example.com&successUrl=https%3A%2F%2Fwww.example.com%2Fsuccess&failureUrl=https%3A%2F%2Fwww.example.com%2Ffailure&cancelUrl=https%3A%2F%2Fwww.example.com%2Fcancel&pendingUrl=https%3A%2F%2Fwww.example.com%2Fpending&locale=en_US&token="
}

Parameters

Parameter	Type	Usage	Description
amount	Number	Required	Payment amount.
description	String	Required	Description of a payment purpose in text format.
currency	String	Required	Payment currency.
invoiceId	String	Optional	Order or Invoice number.
accountId	String	Required	Payer's identifier. If specified, the payment token will be returned in the Notification which can be used for payouts.
successUrl	String	Required	URL the user gets redirected, after the successful charge transaction.
failureUrl	String	Required	URL the user gets redirected, after the charge transaction has failed.
pendingUrl	String	Required	URL the user gets redirected when the charge transaction status cannot be immediately returned. The merchant should expect to receive the end status of the transaction in Notification.
cancelUrl	String	Required	URL the user gets redirected, after the payment was cancelled by the user.
locale	String	Optional	Payment form language. The default language is English when the parameter is not specified.

Body

Parameter	Type	Description
userReferenceId	String	Customer identifier in external payment system that is used for payment performing.
phone	String	Phone number of the customer.
email	String	Customer email address.
address	String	Address of customer.
city	String	City of customer address.
firstName	String	Customer first name.
lastName	String	Customer last name.
countryCode	String	Customer country code.
postcode	String	Postal code of customer address.
state	String	State of customer address.
birthDate	String	Customer day of birth.

API

API is an application program interface to interact with Merchant's system.

Interface works on api-back.paygames.net and provides functionality for making a payment, refunding, and payouts.

The system returns a response in JSON format which includes at least two parameters: success and message:

{ "Success": false, "Message": "Invalid Amount value" }

Requests authentication

For authentication HTTP Basic Auth is used which is sending a login and a password in a header of HTTP request. Public ID serves as a login and API Secret serves as a password. Both of these values you can get in the back office.

Duplicate requests protection

invoiceId parameter is used to identify the uniqueness of the request sent from the Merchant to the System. That means you can send several requests to the system with the same invoiceId identifier, and only one request will be processed. The following requests with the same invoiceId will be Declined. Thus the protection against network errors is implemented which can lead to creation of duplicate records and actions. The time interval when the System considers the received invoiceId is duplicate can be configured individually per Merchant.

POST https://api-back.paygames.net/test

Test

The method to test the interaction with the API.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Responses

200 The method returns a request status.

{"success": true, "message": "Test message success"}

POST https://api-back.paygames.net/payments/charge/card

Payment

The method to request a payment with Card data supplied. This method is used when the Card data is collected on the merchant's side.

Parameters

Header

Header	Type	Description
Authorization*	string	HTTP Basic authentication.
Content-Type*	string	application/json.

Body

Parameter	Type	Description
publicId*	string	Merchant identifier. Located in the Back Office.
amount*	number	Payment amount.
currency*	string	Payment currency.
name*	string	Cardholder's name.
description*	string	Description.
card*	object	Card data of a payment. See the example below for the card data object structure.
invoiceId	string	Order or invoice number.
accountId*	string	Payer's e-mail address. If specified, the payment token will be returned which can be used for Payouts.
ip*	string	Payer's IP address.
successRedirectUrl	string	URL the user gets redirected to after the successful charge transaction. This parameter is used only when the integration supports "Redirect 3-DS" schema.
failureRedirectUrl	string	URL the user gets redirected to after the charge transaction has failed. This parameter is used only when the integration supports "Redirect 3-DS" schema.
pendingRedirectUrl	string	URL the user gets redirected to when the end status of the transaction cannot be retrieved yet. This parameter is used only when the integration supports "Redirect 3-DS" schema.

Responses

{ "success": true, "message": null, "model": { "transactionId": 524, "amount": 40.11, "currency": "EUR", "invoiceId": "9276334", "accountId": "john@doe.com", "description": "Payment for products", "name": "John Doe", "token": "8163-KS17-JV29-KF28", "statusCode": 4, "status": "Completed", "reasonCode": 0, "reason": "Approved" } }

Payment request example

{
	"publicId": "pbid_2kajhh9oqhmpwjqgd529rg",
	"amount": 40.11,
	"currency": "EUR",
	"name": "John Doe",
	"invoiceId": "927829",
	"description": "Payment for products",
	"accountId": "john@doe.com",
	"successRedirectUrl": example.com,
	"failureRedirectUrl": example.com,
	"pendingRedirectUrl": example.com,
	"ip": 10.10.10.10
	"card": {
		"publicId": "pbid_2kajhh9oqhmpwjqgd529rg",
		"pan": "4242424242424242",
		"cvv": "123",
		"expiryMonth": 12,
		"expiryYear": 2023
	},
	"browserInfo": {
		"browserColorDepth": "24",
		"javaEnabled": "false",
		"browserScreenHeight": "600",
		"browserScreenWidth": "800",
		"browserLanguage": "en_US",
		"browserAcceptHeader": "text/html,application/xhtml+xml,application/xml",
		"browserTZ": "+120",
		"browserUserAgent": "AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0"
	},
	"data": {
		"userReferenceId": "12345",
		"countryCode": "UK",
		"city": "London",
		"address": "Wall Street 15",
		"postcode": "12384",
		"phone": "441632960909",
		"state": "",
		"birthDate": "1980-04-25",
		"firstName": "John",
		"lastName": "Doe",
		"email": "test@test.com
	}
}

Responses

{
	"success": true,
	"message": null,
	"model": {
		"transactionId": 524,
		"amount": 40.11,
		"currency": "EUR",
		"invoiceId": "9276334",
		"accountId": "john@doe.com",
		"description": "Payment for products",
		"name": "John Doe",
		"token": "8163-KS17-JV29-KF28",
		"statusCode": 4,
		"status": "Completed",
		"reasonCode": 0,
		"reason": "Approved"
	}
}

{
	"success": false,
	"message": "Insufficient funds to process the transaction",
	"model": {
		"transactionId": 524,
		"amount": 2873.00,
		"currency": "EUR",
		"invoiceId": "9276334",
		"accountId": "john@doe.com",
		"description": "Payment",
		"name": "John Doe",
		"token": null,
		"statusCode": 99,
		"status": "Declined",
		"reasonCode": 5051,
		"reason": "Insufficient Funds"
	}
}

Payment response depends on the processing card. If the card participates in 3-D Secure, in Redirect 3-DS schema the response will contain a link, the user should be redirected to, to complete the 3-D Secure authentication.

{
	"success": false,
	"message": "Requires 3DS authentication",
	"threeDsRedirectModel": {
		"url": "https://payment.checkoutdirect.net/redirect/?link_reference=437b2e80220a11bc8b532f4e2aa8c471",
		"transactionId": 525,
		"statusCode": 1,
		"status": "AwaitingAuthentication"
	}
}

After completing the 3-D Secure verification, depending on the verification results, the user gets redirected either to successRedirectUrl or failureRedirectUrl or pendingRedirectUrl parameter value, supplied in the Payment request.

{
	"success": false,
	"message": "Requires 3DS authentication",
	"threeDsModel": {
		"transactionId": 529,
		"method": "post",
		"paReq": "eNpdU8tymzAU3ecrvMumYz1AgD2yZnDsTpMZx06TRdudLK5skhiIgNjust/Tr+qXVMIm4DDDoHvuOdKZexB/2hqA2SOo2oC4Ggz4AspSbmCQJpPrSELAZKApSOyFkWYaY+brJAq0pzTQa6ewmlX8Hd4aRZDoKMIs8WXiK2/NvIAFDPwwoRrCkV6fFVbzDqZM80yQIR5SjtqybRcyE4xFPmUhoZiGhPkRRw5tGQswaiuzqgUsJNXb9PZeMBpYFUfnsuvvwNzOBKa4fTg6QR0lkzsQ84PcFa/AUVN1TZXXWWWOgmLrpS26dm1exbaqijFC+/1+CKddhrnZII5cs7WOPnvnq9oBZf+wQ5qIxSzed+/8uPj9QO6flb98iiccOUbHT2QF1hlhmODRgARj6o0Z46jBezPaOd/i35+/hH7x7ATOQMconJf4hBLqKH2kN43aGMjUUYxCN4626ghwKPIMrMbm+7HuGYZSCevPfT4m83kQ/ObbRcCqsnHls7V++fVAHoPlnb/9eVMuVz+m8fzrNN5MXOwN6cJHaoMiETkZSbvUOGr3t0e7v7i5A+h8CcQVR5cX5D/FxN2u",
		"acsUrl": "http://ascbank.redisecure.com/ascpage/cap?id=8276844",
		"statusCode": 1,
		"status": "AwaitingAuthentication"
	}
}

In the Advanced 3-DS schema, to complete 3-D Secure authentication, merchant needs to forward a payer to the address specified in the acsUrl parameter of the server's response with following parameters:

MD — transactionId parameter from server response.
PaReq — same parameter from server response.
TermUrl — the address on your site for returning the payer once authentication successful.

Form example

<form name="paymentForm" action="AcsUrl" method="POST">
	<input type="hidden" name="PaReq" value="eNpdU8tymzAU3ecrvMumYz1AgD2yZnDsTpMZx06TRdudLK5skhiIgNjust/Tr+qXVMIm4DDDoHvuOdKZexB/2hqA2SOo2oC4Ggz4AspSbmCQJpPrSELAZKApSOyFkWYaY+brJAq0pzTQa6ewmlX8Hd4aRZDoKMIs8WXiK2/NvIAFDPwwoRrCkV6fFVbzDqZM80yQIR5SjtqybRcyE4xFPmUhoZiGhPkRRw5tGQswaiuzqgUsJNXb9PZeMBpYFUfnsuvvwNzOBKa4fTg6QR0lkzsQ84PcFa/AUVN1TZXXWWWOgmLrpS26dm1exbaqijFC+/1+CKddhrnZII5cs7WOPnvnq9oBZf+wQ5qIxSzed+/8uPj9QO6flb98iiccOUbHT2QF1hlhmODRgARj6o0Z46jBezPaOd/i35+/hH7x7ATOQMconJf4hBLqKH2kN43aGMjUUYxCN4626ghwKPIMrMbm+7HuGYZSCevPfT4m83kQ/ObbRcCqsnHls7V++fVAHoPlnb/9eVMuVz+m8fzrNN5MXOwN6cJHaoMiETkZSbvUOGr3t0e7v7i5A+h8CcQVR5cX5D/FxN2u">
	<input type="hidden" name="MD" value="529">
	<input type="hidden" name="TermUrl" value="https://merchant.example.com/post3ds?orderId=82794">
</form>
<script>
	window.onload = submitForm;
	function submitForm() { paymentForm.submit(); }
</script>

To complete the payment, use the following post3ds method.

POST https://api-back.paygames.net/payments/post3ds

Post 3-D Secure

The method to validate payment's 3-D Secure authentication.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type*	string	application/json.

Body

Parameter	Type	Description
transactionId*	integer	MD (transactionId) parameter value.
paRes*	string	Received PaRes value.

Responses

The server will return either information about successful transaction or declined in response to correctly created request.

POST https://api-back.paygames.net/payments/refund

Refund

The method to return the funds of a successfully completed charge operation.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type*	string	application/json.

Body

Parameter	Type	Description
transactionId*	integer	Transaction ID of successfully completed charge transaction.
amount	string	Refund amount. If the amount is not provided, the transaction is refunded in full of the initial charge amount. The transaction can be refunded partially as well.

Responses

{ "model": { "transactionId": 1039 }, "success": true, "message": null }

Request example

{
	"transactionId": 524, 
	"amount": 13.34
}

POST https://api-back.paygames.net/payments/payout

Payout via token

The method to payout the funds to a Card by provided token.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type*	string	application/json.

Body

Parameter	Type	Description
token*	string	Token of the card. The token is received in response message after the successful Payment API method call.
amount*	number	Payout amount.
accountId*	string	Payer's e-mail address.
currency*	string	Payout currency.
invoiceId	string	Order or invoice number.

Responses

{ "success": true, "message": null, "model": { "transactionId": 2533, "amount": 12.30, "currency": "EUR", "invoiceId": null, "accountId": "john@doe.com", "name": "John Doe", "statusCode": 7, "status": "PayoutCompleted", "reasonCode": 0, "reason": "Approved" } }

Request example

{
	"token": "8163-KS17-JV29-KF28",
	"amount": 12.30,
	"accountId": "john@doe.com",
	"currency": "EUR"
}

POST https://api-back.paygames.net/payments/payout/card

Payout to card

Payout method when the funds are transferred to the provided credit card.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type*	string	application/json.

Body

Parameter	Type	Description
pan*	string	Card number.
name*	string	Cardholder name.
amount*	number	Payout amount.
currency*	string	Payout currency.
invoiceId	string	Order or invoice number.
data	string	Payout recipient additional data.

Responses

{ "success": true, "message": null, "model": { "transactionId": 2533, "amount": 12.30, "currency": "EUR", "invoiceId": "11928485", "accountId": null, "name": "John Doe", "statusCode": 7, "status": "PayoutCompleted", "reasonCode": 0, "reason": "Approved" } }

Request example

{
	"pan": "4242424242424242",
	"name": "John Doe",
	"amount": 12.30,
	"currency": "EUR",
	"invoiceId": "11928485",
	"data": {
		"phone": "+999389235",
		"address": "Wall street 65",
		"city": "New York",
		"countryCode": "US",
		"birthDate": "1980-11-25"
	}
}

POST https://api-back.paygames.net/payments/status

Status

Returns the current status of the requested transaction.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type*	string	application/json.

Body

Parameter	Type	Description
transactionId*	string	Transaction ID to check the status of.

Responses

{ "model": { "transactionId": 144221, "amount": 12.30, "currency": "EUR", "invoiceId": "11928485", "accountId": "john@doe.com", "name": "John Doe", "statusCode": 4, "status": "Completed", "reasonCode": 0, "reason": "Approved", "operationTypeCode": 1, "operationType": "Payment" }, "success": true, "message": null }

Request example

{
	"transactionId": 144221
}

POST https://api-back.paygames.net/payments/status/invoice

Status Invoice

Returns the current status of the requested transaction.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type*	string	application/json.

Body

Parameter	Type	Description
invoiceId*	string	Transaction ID to check the status of.

Responses

{ "success": true, "message": null, "transactions": [ { "transactionId": 501166, "amount": 2.54, "currency": "EUR", "invoiceId": "1781", "accountId": "john@deer.com", "name": "John Deer", "statusCode": 4, "status": "Completed", "reasonCode": 0, "reason": "Approved", "operationTypeCode": 1, "operationType": "Payment" }, { "transactionId": 501167, "amount": 2.54, "currency": "EUR", "invoiceId": "1781", "accountId": "john@deer.com", "name": "John Deer", "statusCode": 99, "status": "Declined", "reasonCode": 6002, "reason": "Duplicate invoice ID", "operationTypeCode": 1, "operationType": "Payment" } ] }

Request example

{
	"invoiceId": "1781"
}

POST https://api-back.paygames.net/payments/list

List

Returns the lists of all transactions for a day.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type*	string	application/json.

Body

Parameter	Type	Description
date*	string	Date when transactions were created in 'YYYY-MM-DD' format.
timezone	string	Transactions date timezone. See Timezones dictionary for available timezones. If timezone is not specified, the transactions are returned based on UTC.

Responses

{ "success": true, "message": null, "transactions": [ { "id": 9876541, "test": false, "statusId": 4, "status": "Completed", "currency": "USD", "amount": 59.99, "description": "order-123", "invoiceId": "inv-234", "accountId": "john.dust@example.com", "created": 1700000000000, "operationTypeId": 1, "operationType": "PayIn", "reasonId": 0, "reason": "Approved", "card": { "cardHolder": "John Dust", "cardBrand": "Mastercard", "cardType": "DEBIT", "cardFirstSix": "660000", "cardLastFour": "3333", "expiryMonth": "07", "expiryYear": "2026", "issuerName": "Test Bank", "issuerCountry": "US" }, "completed": 1700003600000, "paymentTransactionId": "876543", "siteId": 88888, "ip": "202.0.123.12" } ] }

Request example

{"date":"2020-10-25", "timezone":"GMT-00:00"}

POST https://api-back.paygames.net/payments/link

Link

The method is used to generate a payment link, where the user can be redirected to proceed with the payment. When the payment is requested, a payment link is generated and returned in the "link" field of the response.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type*	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
currency*	string	Payment currency.
description*	string	Payment description in text format.
invoiceId	string	Order or invoice number.
accountId*	string	Payer's identifier.
successUrl	string	The URL address the user gets redirected after successful payment operation.
failureUrl	string	The URL address the user gets redirected after the payment transaction has failed.
pendingUrl	string	The URL address the user gets redirected when the payment processing is pending.
cancelUrl	string	The URL address the user gets redirected when the payment has been cancelled by the user.
locale	string	Payment form language. English language is used by default when no locale specified.
ip*	string	IP address of the payer.
data	object	Additional data required for the payment processing. See request example for available fields in the data object.

Responses

{ "paymentLink": "https://payment.paygames.net/payment.html?publicId=pbid_3le07jzwsy7tm8psupndmtvo&amount=234.12&description=Payment&currency=EUR&invoiceId=0001&accountId=test@gmail.com&successUrl=https%3A%2F%2Fwww.example.com%2Fsuccess&failureUrl=https%3A%2F%2Fwww.example.com%2Ffailure&cancelUrl=https%3A%2F%2Fwww.example.com%2Fcancel&token=7tB0d8z1w7qDt5c7cMI9TBALOwzxi0Oo" }

Request example

{
	"amount": 10.66,
	"currency": "USD",
	"description": "Payment for products",
	"invoiceId": "990022",
	"accountId": "john@doe.com",
	"successUrl": "https://example.com/success",
	"failureUrl": "https://example.com/failure",
	"pendingUrl": "https://example.com/pending",
	"cancelUrl": "https://example.com/cancel",
	"locale": "en_US", 
	"ip": "10.20.30.40",
	"data": {
		"personId": "4000878749933",
		"phone": "+73838247553",
		"address": "Wall Street 14-49",
		"city": "New York",
		"firstName": "John",
		"lastName": "Doe",
		"countryCode": "BR",
		"paymentTypeId": 1000
	}
}

GET https://api-back.paygames.net/payments/balance

Balance

Returns the list of available accounts and balance. The balance is calculated taking into account the amount of successful payments, payouts, holds and fees.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type*	string	application/json.

Responses

{ "success": true, "message": null, "balances": [ { "name": "The balance", "currencies": [ { "currency": "EUR", "total": 14633.00, "pending": 0.00, "hold": 481.70, "fee": 529.98, "pendingFee": 0.00, "available": 13621.32 }, { "currency": "USD", "total": 59483.00, "pending": 503.00, "hold": 3220.70, "fee": 1003.98, "pendingFee": 45.10, "available": 54710.22 }, ] } ] }

Response fields description

Parameter	Type	Description
currency	String	Balance currency.
total	Number	Total funds amount on the balance.
pending	Number	Funds that are reserved for ongoing transactions.
hold	Number	Funds on hold.
fee	Number	Acquiring and other fees.
pendingFee	Number	Funds that are reserved for ongoing fees.
available	Number	Funds available for operations.

APM payins

APM payin example for Malaysia, MYR (29004)

Request example

{
  "amount": 100.50,
  "description": "Payment for services rendered",
  "currency": "MYR",
  "invoiceId": "INV123456",
  "accountId": "acc123456",
  "successUrl": "https://example.com/success",
  "failureUrl": "https://example.com/failure",
  "pendingUrl": "https://example.com/pending",
  "cancelUrl": "https://example.com/cancel",
  "locale": "en_US",
  "ip": "192.168.1.1",
  "data": {
    "phone": "+1234567890",
    "address": "123 Main Street",
    "city": "Anytown",
    "state": "Anystate",
    "firstName": "John",
    "lastName": "Doe",
    "countryCode": "US",
    "postcode": "12345",
    "paymentTypeId": 29004
  }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for Singapore, SGD (23039)

Request example

{
  "amount": 100.50,
  "description": "Payment for services rendered",
  "currency": "SGD",
  "invoiceId": "INV123456",
  "accountId": "acc123456",
  "successUrl": "https://example.com/success",
  "failureUrl": "https://example.com/failure",
  "pendingUrl": "https://example.com/pending",
  "cancelUrl": "https://example.com/cancel",
  "locale": "en_US",
  "ip": "192.168.1.1",
  "data": {
    "phone": "+1234567890",
    "address": "123 Main Street",
    "city": "Anytown",
    "state": "Anystate",
    "firstName": "John",
    "lastName": "Doe",
    "countryCode": "US",
    "postcode": "12345",
    "paymentTypeId": 23039
  }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for India, INR, UPI QR (2080)

Request example

{
  "amount": 103.21,
  "description": "Payin test 103.21",
  "currency": "INR",
  "invoiceId": "invoice-test",
  "accountId": "818666@exemple",
  "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": "IN",
  "ip": "92.253.212.180",
  "data": {
    "personId": 22671, 
    "phone": "+1111111111",
    "address": null,
    "city": null,
    "firstName": "John",
    "lastName": "Dou",
    "countryCode": "IN",
    "paymentTypeId": 2080
  }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Japan, JPY (29014)

Request example

{
  "amount": 100.50,
  "description": "Payment for services rendered",
  "currency": "JPY",
  "invoiceId": "INV123456",
  "accountId": "acc123456",
  "successUrl": "https://example.com/success",
  "failureUrl": "https://example.com/failure",
  "pendingUrl": "https://example.com/pending",
  "cancelUrl": "https://example.com/cancel",
  "locale": "en_US",
  "ip": "192.168.1.1",
  "data": {
    "phone": "+1234567890",
    "address": "123 Main Street",
    "city": "Anytown",
    "state": "Anystate",
    "firstName": "John",
    "lastName": "Doe",
    "countryCode": "US",
    "postcode": "12345",
    "paymentTypeId": 29014
  }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for India, INR, UPI (2000)

Request example

{
  "amount": 700.31,
  "description": "sale",
  "currency": "INR",
  "accountId": "test@test.com",
  "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",
  "ip": "10.10.1.74",
  "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/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for Brazil, BRL, PIX (26000)

Request example

{
  "amount": 1.50,
  "description": "sale",
  "currency": "BRL",
  "invoiceId": "fJxEYRzm01boZiurSLOY6ZLvfJxEYRzm01boZiurSLOY6ZLv",
  "accountId": "test@gmail.com",
  "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/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for Thailand, THB, bank transfer (29001)

Request example

{
 "amount": 10000,
 "description": "Payment for services rendered",
 "currency": "THB",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29001
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

{ "paymentLink": "https://payment.paygames.net/payment.html?publicId=pbid_3le07jzwsy7tm8psupndmtvo&amount=10000&description=Payment&currency=THB&invoiceId=INV123456&accountId=test@test.com&successUrl=https%3A%2F%2Fexample.com%2Fsuccess&failureUrl=https%3A%2F%2Fexample.com%2Ffailure&pendingUrl=https%3A%2F%2Fexample.com%2Fpending&cancelUrl=https%3A%2F%2Fexample.com%2Fcancel&token=7tB0d8z1w7qDt5c7cMI9TBALOwzxi0Oo" }

APM payin example for Thailand, THB, QR payment (29002)

Request example

{
 "amount": 10000,
 "description": "Payment for services rendered",
 "currency": "THB",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29002
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for Thailand, THB, E-wallet (29003)

Request example

{
 "amount": 10000,
 "description": "Payment for services rendered",
 "currency": "THB",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29003
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for Vietnam, VND, Bank transfer (29005)

Request example

{
 "amount": 10000,
 "description": "Payment for services rendered",
 "currency": "VND",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29005
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

{ "paymentLink": "https://payment.paygames.net/payment.html?publicId=pbid_3le07jzwsy7tm8psupndmtvo&amount=10000&description=Payment&currency=VND&invoiceId=INV123456&accountId=test@test.com&successUrl=https%3A%2F%2Fexample.com%2Fsuccess&failureUrl=https%3A%2F%2Fexample.com%2Ffailure&pendingUrl=https%3A%2F%2Fexample.com%2Fpending&cancelUrl=https%3A%2F%2Fexample.com%2Fcancel&token=7tB0d8z1w7qDt5c7cMI9TBALOwzxi0Oo" }

APM payin example for Vietnam, VND, QR payment (29006)

Request example

{
 "amount": 10000,
 "description": "Payment for services rendered",
 "currency": "VND",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29006
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for Vietnam, VND, Momo Pay (29007)

Request example

{
 "amount": 10000,
 "description": "Payment for services rendered",
 "currency": "VND",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29007
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for Vietnam, VND, Zalo Pay (29008)

Request example

{
 "amount": 10000,
 "description": "Payment for services rendered",
 "currency": "VND",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29005
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for Indonesia, IDR (29000)

Request example

{
 "amount": 10000,
 "description": "Payment for services rendered",
 "currency": "IDR",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29000
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

{ "paymentLink": "https://payment.paygames.net/payment.html?publicId=pbid_3le07jzwsy7tm8psupndmtvo&amount=10000&description=Payment&currency=IDR&invoiceId=INV123456&accountId=test@test.com&successUrl=https%3A%2F%2Fexample.com%2Fsuccess&failureUrl=https%3A%2F%2Fexample.com%2Ffailure&pendingUrl=https%3A%2F%2Fexample.com%2Fpending&cancelUrl=https%3A%2F%2Fexample.com%2Fcancel&token=7tB0d8z1w7qDt5c7cMI9TBALOwzxi0Oo" }

APM payin example for Philippines, PHP, G Cash (29009)

Request example

{
 "amount": 1000,
 "description": "Payment for services rendered",
 "currency": "PHP",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29009
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

{ "paymentLink": "https://payment.paygames.net/payment.html?publicId=pbid_3le07jzwsy7tm8psupndmtvo&amount=1000&description=Payment&currency=PHP&invoiceId=INV123456&accountId=test@test.com&successUrl=https%3A%2F%2Fexample.com%2Fsuccess&failureUrl=https%3A%2F%2Fexample.com%2Ffailure&pendingUrl=https%3A%2F%2Fexample.com%2Fpending&cancelUrl=https%3A%2F%2Fexample.com%2Fcancel&token=7tB0d8z1w7qDt5c7cMI9TBALOwzxi0Oo" }

APM payin example for Philippines, PHP, G Cash QR (29010)

Request example

{
 "amount": 1000,
 "description": "Payment for services rendered",
 "currency": "PHP",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29010
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for Philippines, PHP (29011)

Request example

{
 "amount": 1000,
 "description": "Payment for services rendered",
 "currency": "PHP",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "en_US",
 "ip": "192.168.1.1",
 "data": {
   "phone": "+1234567890",
   "address": "123 Main Street",
   "city": "town",
   "state": "state",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "US",
   "postcode": "12345",
   "paymentTypeId": 29011
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment 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

APM payin example for Peru, PEN, Cash, Tambo (24046)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 24046
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

{ "paymentLink": "https://payment.paygames.net/payment.html?publicId=pbid_3le07jzwsy7tm8psupndmtvo&amount=100.50&description=test&currency=PEN&invoiceId=INV123456&accountId=alex@gmail.com&successUrl=https%3A%2F%2Fexample.com%2Fsuccess&failureUrl=https%3A%2F%2Fexample.com%2Ffailure&pendingUrl=https%3A%2F%2Fexample.com%2Fpending&cancelUrl=https%3A%2F%2Fexample.com%2Fcancel&token=7tB0d8z1w7qDt5c7cMI9TBALOwzxi0Oo" }

APM payin example for Peru, PEN, Cash, Western Union (24047)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 24047
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Cash, Kasnet (24055)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 24055
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Pago Efectivo Cash (32060)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32060
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, BBVA Continental Online (32086)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32086
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Interbank Online (32087)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32087
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Scotiabank Online (32088)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32088
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Caja Huancayo Online (32089)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32089
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Caja Arequipa Online (32090)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32090
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Caja Tacna Online (32091)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32091
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Caja Trujillo Online (32092)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32092
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Banco de Crédito Online (32095)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32095
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Banco de Crédito Cash (32096)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32096
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, BBVA Continental Cash (32097)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32097
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Scotiabank Cash (32098)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32098
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Caja Huancayo Cash (32099)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32099
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Caja Arequipa Cash (32100)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32100
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Caja Tacna Cash (32101)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32101
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Caja Trujillo Cash (32102)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32102
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Banco Ripley Cash (32103)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32103
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for Peru, PEN, Khipu Online (32113)

Request example

{
 "amount": 100.50,
 "description": "test",
 "currency": "PEN",
 "invoiceId": "INV123456",
 "accountId": "alex@gmail.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "documentId": "490376497",
   "phone": "+7596874748",
   "firstName": "John",
   "lastName": "Doe",
   "countryCode": "PE",
   "paymentTypeId": 32113
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.documentId*	string	Payer's document ID.
data.phone*	string	Payer's phone number.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.countryCode*	string	Payer's country code.
data.paymentTypeId*	number	Payment type identifier.

Responses

APM payin example for South Korea, KRW, Virtual account (29013)

Request example

{
 "amount": 10000,
 "description": "test",
 "currency": "KRW",
 "invoiceId": "INV123456",
 "accountId": "test@test.com",
 "successUrl": "https://example.com/success",
 "failureUrl": "https://example.com/failure",
 "pendingUrl": "https://example.com/pending",
 "cancelUrl": "https://example.com/cancel",
 "locale": "EN",
 "ip": "192.168.1.1",
 "data": {
   "personId": "1234567890",
   "firstName": "John",
   "lastName": "Deer",
   "phone": "9555777666",
   "address": "18-5, Chunui-dong",
   "paymentTypeId": 29013
 }
}

POST https://api-back.paygames.net/payments/link

Payin to account

Payin method when funds are transferred to the specified account.

Parameters

Header

Header	Type	Description
Authorization	string	HTTP Basic authentication.
Content-Type	string	application/json.

Body

Parameter	Type	Description
amount*	number	Payment amount.
description*	string	Description of payment.
currency*	string	Payment currency.
accountId*	string	Account identifier (email).
invoiceId	string	Order or invoice number.
successUrl*	string	URL for successful payment.
failureUrl*	string	URL for failed payment.
pendingUrl*	string	URL for pending payment.
cancelUrl*	string	URL for cancelled payment.
locale*	string	Locale for payment form.
ip*	string	Payer's IP address.
data	object	Additional payment data.
data.personId*	string	Person's identifier.
data.firstName*	string	Payer's first name.
data.lastName*	string	Payer's last name.
data.phone*	string	Payer's phone number.
data.address*	string	Payer's address.
data.paymentTypeId*	number	Payment type identifier.

Responses

{ "paymentLink": "https://payment.paygames.net/payment.html?publicId=pbid_3le07jzwsy7tm8psupndmtvo&amount=10000&description=Payment&currency=KRW&invoiceId=INV123456&accountId=test@test.com&successUrl=https%3A%2F%2Fexample.com%2Fsuccess&failureUrl=https%3A%2F%2Fexample.com%2Ffailure&pendingUrl=https%3A%2F%2Fexample.com%2Fpending&cancelUrl=https%3A%2F%2Fexample.com%2Fcancel&token=7tB0d8z1w7qDt5c7cMI9TBALOwzxi0Oo" }

APM payouts

APM 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

{ "model": { "transactionId": 99964, "amount": 500.0, "currency": "INR", "invoiceId": "INV123", "accountId": "test@test.com", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99964, "amount": 100.50, "currency": "MYR", "invoiceId": "INV123456", "accountId": "test@test.com", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99964, "amount": 100.50, "currency": "SGD", "invoiceId": "INV123456", "accountId": "test@test.com", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99964, "amount": 55.67, "currency": "INR", "invoiceId": "invoice-payout-test-124", "accountId": "88666@exemple", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99964, "amount": 100.50, "currency": "JPY", "invoiceId": "INV123456", "accountId": "test@test.com", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99964, "amount": 1.50, "currency": "INR", "invoiceId": "INV123456", "accountId": "test@test.com", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99964, "amount": 1.50, "currency": "BRL", "invoiceId": "fJxEYRzm01boZiurSLOY6ZLvfJxEYRzm01boZiurSLOY6ZLv", "accountId": "test@gmail.com", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99964, "amount": 10000, "currency": "THB", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

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

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

{ "model": { "transactionId": 99964, "amount": 10000, "currency": "VND", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99964, "amount": 10000, "currency": "IDR", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99964, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99965, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99966, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99967, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99968, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99969, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99970, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99971, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99972, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99973, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99974, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99975, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99976, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99977, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99978, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99979, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99980, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99981, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99982, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99983, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99984, "amount": 114.31, "currency": "PEN", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": "John Doe", "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

{ "model": { "transactionId": 99964, "amount": 10000, "currency": "PHP", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

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

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

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

{ "model": { "transactionId": 99964, "amount": 10000, "currency": "KRW", "invoiceId": "INV123456789", "accountId": "ACC123456789", "name": null, "statusCode": 10, "status": "Created", "reasonCode": 0, "reason": "Approved" }, "success": true, "message": null }

Notifications

Notification is an HTTP request from the system to your site. Similar requests are also called callback or webhook. The system provides notifications about successful and unsuccessful payments.

Payment success

The Success notification is performed once a payment is successfully completed. It serves the purpose of information about a payment: the system sends a request to a merchant's website address with payment information, and the merchant's site has to register the fact of payment.

{
  "cardFirstSix": "551928",
  "cardLastFour": "0000",
  "cardType": "Mastercard",
  "cardExpDate": "12/2024",
  "name": "John Doe",
  "token": "d134518a-1dc2-4254-8229-2b56d58859d3fae4c743-4a31-426e-b0dc-4d4c6411cb1c",
  "transactionId": 132415,
  "amount": 251,
  "currency": "MXN",
  "dateTime": "2024-04-11 08:41:23",
  "invoiceId": "124213",
  "accountId": "test@mail.com",
  "operationTypeCode": 1,
  "operationType": "PayIn",
  "status": "Completed",
  "statusCode": 4,
  "data": "{\"city\": \"ExampleCity\", \"email\": \"john.doe@example.com\", \"phone\": \"1234567890\", \"state\": \"ExampleState\", \"address\": \"Example Address\", \"lastName\": \"Doe\", \"postcode\": \"12345\", \"birthDate\": \"1990-01-01\", \"firstName\": \"John\", \"countryCode\": \"US\", \"userReferenceId\": \"yourUserReferenceId\"}"
}

Parameter	Type	Usage	Description
transactionId	Integer	Required	Transaction number in the system.
amount	Number	Required	Amount.
currency	String	Required	Currency.
dateTime	String	Required	Date and time.
invoiceId	String	Optional	Invoice or order number.
accountId	String	Optional	Payer's identifier.
operationTypeCode	Integer	Required	Transaction operation code.
operationType	String	Required	Transaction operation ("Payment").
status	String	Required	Transaction status ("Completed").
statusCode	Integer	Required	Transaction status code.
cardFirstSix	String	Required	Transaction Card PAN first 6 numbers.
cardLastFour	String	Required	Transaction Card PAN last 4 numbers.
cardType	String	Required	Card type (VISA, Mastercard, Amex).
cardExpDate	String	Required	Card expiry date in MM/YYYY format.
name	String	Optional	Cardholder's name.
token	String	Optional	Payment card's token. Returned only if accountId was provided during the payment.

Payment failure

In the event of a payment failure, the merchant is able to receive a notification with transaction details and failure explanation.

{
  "cardFirstSix": "424242",
  "cardLastFour": "4242",
  "cardType": "Visa",
  "cardExpDate": "12/2024",
  "name": "John Doe",
  "reasonCode": 5006,
  "reason": "Error",
  "transactionId": 132412,
  "amount": 225.33,
  "currency": "MXN",
  "dateTime": "2024-04-11 08:38:01",
  "invoiceId": "123123",
  "accountId": "45",
  "operationTypeCode": 1,
  "operationType": "PayIn",
  "status": "Declined",
  "statusCode": 99,
  "data": "{\"city\": \"ExampleCity\", \"email\": \"john.doe@example.com\", \"phone\": \"1234567890\", \"state\": \"ExampleState\", \"address\": \"Example Address\", \"lastName\": \"Doe\", \"postcode\": \"12345\", \"birthDate\": \"1990-01-01\", \"firstName\": \"John\", \"countryCode\": \"US\", \"userReferenceId\": \"yourUserReferenceId\"}"
}

Parameter	Type	Usage	Description
transactionId	Integer	Required	Transaction number in the system.
amount	Number	Required	Amount.
currency	String	Required	Currency.
dateTime	String	Required	Date and time.
invoiceId	String	Optional	Invoice or order number.
accountId	String	Optional	Payer's identifier.
operationTypeCode	Integer	Required	Transaction operation code.
operationType	String	Required	Transaction operation ("Payment").
status	String	Required	Transaction status ("Declined").
statusCode	Integer	Required	Transaction status code.
cardFirstSix	String	Required	Transaction Card PAN first 6 numbers.
cardLastFour	String	Required	Transaction Card PAN last 4 numbers.
cardType	String	Required	Card type (VISA, Mastercard, Amex).
cardExpDate	String	Required	Card expiry date in MM/YYYY format.
name	String	Optional	Cardholder's name.
reason	String	Required	Transaction failure reason.
reasonCode	Integer	Required	Transaction failure reason code.

Refund success

The Refund Success notification is performed if a payment was refunded (fully or partially) on your initiative via the API or Back Office.

{
  "paymentTransactionId": 137350,
  "transactionId": 137351,
  "amount": 225.33,
  "currency": "MXN",
  "dateTime": "2024-04-17 08:07:57",
  "invoiceId": "123123",
  "accountId": "45",
  "operationTypeCode": 2,
  "operationType": "Refund",
  "status": "RefundCompleted",
  "statusCode": 5,
  "data": null
}

Parameter	Type	Usage	Description
paymentTransactionId	Integer	Required	Transaction number of the initial payment in the system.
transactionId	Integer	Required	Refund transaction number in the system.
amount	Number	Required	Refund amount.
currency	String	Required	Currency.
dateTime	String	Required	Date and time.
invoiceId	String	Optional	Invoice or order number.
accountId	String	Optional	Payer's identifier.
operationTypeCode	Integer	Required	Transaction operation code.
operationType	String	Required	Transaction operation ("Refund").
status	String	Required	Transaction status ("RefundCompleted").
statusCode	Integer	Required	Transaction status code.

Refund failure

The Refund Failure notification is performed if a payment refund request (full or partial) has failed.

{
  "paymentTransactionId": 8226,
  "reasonCode": 5006,
  "reason": "URI is not absolute",
  "transactionId": 8280,
  "amount": 100,
  "currency": "MXN",
  "dateTime": "2024-02-05 15:38:35",
  "invoiceId": "123123",
  "accountId": "45",
  "operationTypeCode": 2,
  "operationType": "Refund",
  "status": "Declined",
  "statusCode": 99,
  "data": null
}

Parameter	Type	Usage	Description
paymentTransactionId	Integer	Required	Transaction number of the initial payment in the system.
transactionId	Integer	Required	Refund transaction number in the system.
amount	Number	Required	Refund amount.
currency	String	Required	Currency.
dateTime	String	Required	Date and time.
invoiceId	String	Optional	Invoice or order number.
accountId	String	Optional	Payer's identifier.
operationTypeCode	Integer	Required	Transaction operation code.
operationType	String	Required	Transaction operation ("Refund").
status	String	Required	Transaction status ("Declined").
statusCode	Integer	Required	Transaction status code.
reason	String	Required	Transaction failure reason.
reasonCode	Integer	Required	Transaction failure reason code.

Payout success

The Payout Success notification is performed if funds were paid out on your initiative via the API or Back Office.

{
  "transactionId": 132421,
  "amount": 33,
  "currency": "MXN",
  "dateTime": "2024-04-11 08:45:19",
  "invoiceId": "12345",
  "accountId": "qweqwe@gmail.com",
  "operationTypeCode": 3,
  "operationType": "CardPayout",
  "status": "PayoutCompleted",
  "statusCode": 7,
  "data": null
}

Parameter	Type	Usage	Description
transactionId	Integer	Required	Payout transaction number in the system.
amount	Number	Required	Payout amount.
currency	String	Required	Currency.
accountId	String	Required	Payer's identifier.
invoiceId	String	Optional	Invoice or order number.
dateTime	String	Required	Date and time.
operationTypeCode	Integer	Required	Transaction operation code.
operationType	String	Required	Transaction operation ("CardPayout").
status	String	Required	Transaction status ("PayoutCompleted").
statusCode	Integer	Required	Transaction status code.

Payout failure

The Payout Failure notification is performed if funds payout request has failed.

{
  "reasonCode": 5006,
  "reason": "ok", 
  "transactionId": 132424,
  "amount": 22,
  "currency": "MXN",
  "dateTime": "2024-04-11 08:46:39",
  "invoiceId": "123444",
  "accountId": "asdasd@gmail.com",
  "operationTypeCode": 3,
  "operationType": "CardPayout",
  "status": "Declined",
  "statusCode": 99,
  "data": null
}

Parameter	Type	Usage	Description
transactionId	Integer	Required	Payout transaction number in the system.
amount	Number	Required	Payout amount.
currency	String	Required	Currency.
accountId	String	Required	Payer's identifier.
invoiceId	String	Optional	Invoice or order number.
dateTime	String	Required	Date and time.
operationTypeCode	Integer	Required	Transaction operation code.
operationType	String	Required	Transaction operation ("CardPayout").
status	String	Required	Transaction status ("Declined").
statusCode	Integer	Required	Transaction status code.
reason	String	Required	Transaction failure reason.
reasonCode	Integer	Required	Transaction failure reason code.

Payment check

The Payment Check notification is performed once a cardholder filled in a payment form and pressed the “Pay” button. It serves the purpose of payment validation: the system sends a request to a merchant's website address with payment information, and the website must validate and reply back if the payment has to be confirmed or rejected.

{
  "transactionId": 136601, 
  "amount": 251,
  "currency": "MXN",
  "dateTime": "2024-04-16 13:01:34",
  "invoiceId": "124213",
  "accountId": "test@mail.com",
  "operationTypeCode": 1,
  "operationType": "PayIn",
  "cardFirstSix": "551928",
  "cardLastFour": "0000",
  "cardType": "Mastercard",
  "cardExpDate": "12/2024",
  "status": "Created",
  "statusCode": 10,
  "name": "John Doe",
  "data": null
}

Parameter	Type	Usage	Description
transactionId	Integer	Required	Payout transaction number in the system.
amount	Number	Required	Payment amount.
currency	String	Required	Payment currency.
dateTime	String	Required	Date and time.
invoiceId	String	Required	Invoice or order number.
accountId	String	Required	Payer's identifier.
name	String	Required	Cardholder's name.
operationTypeCode	Integer	Required	Transaction operation code.
operationType	String	Required	Transaction operation ("Payment").
cardFirstSix	String	Required	Transaction Card PAN first 6 numbers.
cardLastFour	String	Required	Transaction Card PAN last 4 numbers.
cardType	String	Required	Card type (VISA, Mastercard, Amex).
cardExpDate	String	Required	Card expiry date in MM/YYYY format.
status	String	Required	Transaction status ("Created").
statusCode	Integer	Required	Transaction status code.

Payment Check notifications expects HTTP status 200 with response in JSON format with the required parameter code:

{"code":0}

Response codes

Payment Check notification expects the code value "0" in order to proceed with the payment. Any other numeric value received with the response will reject the payment processing.

Notification confirmation

Parameter	Type	Description
code	Integer	Notification confirmation code.

Notification confirmation example

{"code":0}

In case the System didn't receive the mentioned success code, notification sending will be repeated 5 times.

Notification validation

All the notifications have the Content-HMAC HTTP header which contains a validation value of a request which is calculated using the HMAC algorithm. If you need to verify authenticity and integrity of notifications, you can calculate a validation value on your side and compare it with the request value. The coincidence confirms that you received the notification we sent in the original form.

For notifications sent by POST method the message is represented by a request body.
Hash is calculated by SHA256 function.
The secret API is used as a key, which can be obtained in your Back Office.
The calculated value is passed in base64 encoding.

HMAC value calculation and encoding example

<?php
	$data = '{"transactionId":512,"amount":30.45,"currency":"EUR"...}';
	$secret = '1234ABCD';
	$hmac_data = hash_hmac('sha256', $data, $secret);
	$hmac_content = base64_encode($hmac_data);
	echo $hmac_content;
?>

Output result:

MzVkMzBlMTdmMmVkNGJkNjFhMzFmNTdhODU0ZGQwZTYwZGU5MDg5MDRiODYyMTAzZmI0ZDAzMjRiMWJmNmM3Mw==

Dictionaries

Transaction status

ID	Status	Description
1	AwaitingAuthentication	Waiting for 3-D Secure authentication.
4	Completed	Payment transaction successful completion.
5	RefundCompleted	Refund transaction successful completion.
7	PayoutCompleted	Payout transaction successful completion.
10	Created	Transaction has been created.
99	Declined	Transaction processing failure.

Transaction operations

ID	Operation	Description
1	Payment	Transaction operation when funds are charged from the credit card.
2	Refund	Operation when funds are returned back to a credit card after the initial Payment operation.
3	CardPayout	Operation when the funds are paid out to a credit card.

Transaction resolutions

ID	Description
0	Approved.
1	Not 3-DS authenticated.
5001	Refer To Card Issuer.
5003	Invalid Merchant.
5004	Pick Up Card.
5005	Do Not Honor.
5006	Error.
5007	Pick Up Card Special Conditions.
5012	Invalid Transaction.
5013	Amount Error.
5014	Invalid Card Number.
5015	No Such Issuer.
5019	Transaction Error.
5030	Format Error.
5031	Bank Not Supported By Switch.
5033	Expired Card Pickup.
5034	Suspected Fraud.
5036	Restricted Card.
5041	Lost Card.
5043	Stolen Card.
5051	Insufficient Funds.
5054	Expired Card.
5057	Transaction Not Permitted.
5062	Restricted Card 2.
5063	Security Violation.
5065	Exceed Withdrawal Frequency.
5082	Incorrect CVV.
5091	Timeout.
5092	Cannot Reach Network.
5096	System Error.
5204	Unable To Process.
5206	Authentication failed.
5207	Authentication unavailable.
5300	Anti Fraud.
6001	Check Failure.
6002	Duplicate invoice ID.
6003	Duplicate transaction.
6010	Daily limit reached.
6011	Monthly limit reached.
6012	Bank limit reached.

Timezones

Timezone ID
GMT-12:00
GMT-11:00
GMT-10:00
GMT-09:00
GMT-08:00
GMT-07:00
GMT-06:00
GMT-05:00
GMT-04:00
GMT-03:00
GMT-02:00
GMT-01:00
GMT-00:00
GMT+01:00
GMT+02:00
GMT+03:00
GMT+04:00
GMT+05:00
GMT+06:00
GMT+07:00
GMT+08:00
GMT+09:00
GMT+10:00
GMT+11:00
GMT+12:00

Test cards

This section provides test cards for testing various types of operations.

Cards for payment operation tests

The system supports four payment scenarios:

Payment successful, without 3D-Secure.
Payment unsuccessful, without 3D-Secure.
Payment successful, with 3D-Secure.
Payment unsuccessful, with 3D-Secure.

These scenarios are selected based on the card number and CVV used during the payment process.

Card number	Expiry	CVV	3-D Secure	Schema	Result
4111 1111 1111 1111	12/24	123	Yes	Advanced	Success
4111 1111 1111 1111	12/24	333	Yes	Advanced	Failure
4200 0000 0000 0000	12/24	123	Yes	Redirect	Success
4200 0000 0000 0000	12/24	333	Yes	Redirect	Failure
4242 4242 4242 4242	12/24	123	No	None	Success
4242 4242 4242 4242	12/24	333	No	None	Failure

Cards for refund operation tests

Card number	Result	Description
4242 4242 4242 4242	RefundCompleted	Successful refund (full or partial).
4111 1111 1111 1111	Declined	All refund requests to this card will be declined by the system.
4200 0000 0000 0000	Created	Refund request will be created, but not processed further until the result is received from the acquiring bank

Cards for card payout operation tests

Card number	Result	Description
4242 4242 4242 4242	PayoutCompleted	Successful payout to a card
4111 1111 1111 1111	Declined	All payout requests to this card will be declined by the system
4200 0000 0000 0000	Created	Payout request will be created, but not processed further until the result is received from the acquiring bank

FAQ

Is there a test environment on the platform?

Yes, there is a test environment for the card method across all currencies. However, for alternative payment methods, there is no test environment.

What parameters are required in the request?

The set of mandatory and optional fields may vary depending on the method and currency. To clarify this information, please contact your dedicated Account Manager.

How can I get request, response or callback examples?

General examples and some methods with detailed information are described in the documentation sections: API, APM Payin, APM Payout. If you cannot find the necessary information in the documentation, please contact your dedicated Account Manager.

Where can I find the logo for a specific payment or payout method?

We recommend searching for all payment method logos in official public sources, depending on the method.

How can I find out your IP Whitelist from which callbacks or webhooks will be sent?

IP Whitelist: 18.153.131.191, 3.64.137.76.

Last modified: 20 December 2024