Set Customizations

post https://pg-sandbox.paymaya.com/payments/v1/customizations

Provides customization settings for the merchant to change some elements on the user interface.

⚠️ For Basic Authentication, use SECRET API KEY. Learn more →

Body Params

logoUrl

string

required

length between 5 and 2082

URL that points to the merchant's logo image.

iconUrl

string

required

length between 5 and 2082

URL that points to the merchant's icon image.

appleTouchIconUrl

string

required

length between 5 and 2082

URL that points to the merchant's Apple icon image.

customTitle

string

required

length between 1 and 64

Customized title used in the web browser.

colorScheme

string

required

The HEX color code that is used for the payment button.

hideReceiptInput

boolean

Defaults to false

Indicates if the merchant does not allow its payers to freely send transaction receipts (i.e. set to true).

skipResultPage

boolean

Defaults to false

Indicates if the merchant does not want to show the payment result page.
When skipped (i.e. set to true), the payment page redirects immediately to the merchant's redirect URL.

showMerchantName

boolean

Defaults to true

Indicates if the merchant name on the result page is displayed.
For merchants that have their name in their logo, they may opt to hide a textual display of their name to remove duplicity.

redirectTimer

number

3 to 30

The number of seconds the payment result page is shown before it redirects to the merchant's redirect URL.

The following are the default time used depending on the resulting payment:

15 seconds: for successful payments
5 seconds: for failed payments

Response

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://pg-sandbox.paymaya.com/payments/v1/customizations \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "hideReceiptInput": false,
8
  "skipResultPage": false,
9
  "showMerchantName": true
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Set Customizations

Payment APIs

Developer resources

More

200Successfully retrieved payment information.

Payment APIs

Developer resources

More