PIX API

POST

/payment

OnlinePay will obtain the HTTP Header referer to verify the website source. The website source must be configured by OnlinePay to be verified. If you do not access the interface through a browser, you need to actively add a referer.

Request

Header Params

Body Params application/json

Example

{
  "merNo": 111111,
  "merOrderNo": "222222",
  "currencyCode": "USD",
  "sourceAmount": "100.05",
  "returnUrl": "https://example.com",
  "notifyUrl": "https://example.com/notify",
  "sign": "906FDF4880B00B00281F2AB61AE9A721",
  "ipAddress": "192.168.1.1",
  "version": "V3.0.0",
  "userId": "111",
  "email": "example@gmail.com",
  "name": "Tony Sliva",
  "socialSecurityNumber": "1234567890"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/payment' \
--header 'paymentType: PIX' \
--header 'Content-Type: application/json' \
--data-raw '{
  "merNo": 111111,
  "merOrderNo": "222222",
  "currencyCode": "USD",
  "sourceAmount": "100.05",
  "returnUrl": "https://example.com",
  "notifyUrl": "https://example.com/notify",
  "sign": "906FDF4880B00B00281F2AB61AE9A721",
  "ipAddress": "192.168.1.1",
  "version": "V3.0.0",
  "userId": "111",
  "email": "example@gmail.com",
  "name": "Tony Sliva",
  "socialSecurityNumber": "1234567890"
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "code": "string",
    "message": "string",
    "data": {
        "payCode": 0,
        "tradeNo": "string",
        "merorderNo": "string",
        "payUrl": "string"
    }
}

Modified at 2026-05-19 09:17:46

Google Pay API

PerTransfer API