Skip to main content
POST
/
payment-requests
cURL
curl --request POST \
  --url https://gateway.cyrexa.com/ipg/2.0.0/payment-requests \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
  "id": 123,
  "ownerId": 123,
  "userId": 123,
  "recipientName": "<string>",
  "paymentRequestStatusId": 0,
  "transactionId": 123,
  "transactionNumber": "<string>",
  "amount": 1,
  "unit": "<string>",
  "payerCountry": "<string>",
  "referenceId": "<string>",
  "notes": "<string>",
  "link": "<string>",
  "createDate": "2023-11-07T05:31:56Z",
  "clientId": 123,
  "clientName": "<string>",
  "clientEmail": "<string>",
  "clientAddress": "<string>",
  "clientPhone": "<string>",
  "clientMemberId": "<string>",
  "client": {
    "id": 123,
    "ownerId": 123,
    "userId": 123,
    "ownerName": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "address": "<string>",
    "phone": "<string>",
    "memberId": "<string>",
    "hasPaymentRequests": true,
    "totalDeposits": 123,
    "createDate": "2023-11-07T05:31:56Z"
  },
  "notifyUrl": "<string>",
  "successUrl": "<string>",
  "failureUrl": "<string>",
  "transactionStatusId": 0,
  "targetAccountTypeId": 0,
  "originDomain": "<string>",
  "chargedBack": true,
  "feeAmount": 123,
  "grossAmount": 123,
  "netAmount": 123,
  "transactionCurrency": "<string>",
  "exchangeRate": 123,
  "cardBin": "<string>",
  "device": "<string>",
  "browser": "<string>",
  "osName": "<string>",
  "cardLastDigits": "<string>",
  "sumSubApplicantId": "<string>",
  "threeDs": true,
  "logMessage": "<string>",
  "logTransactionId": "<string>",
  "logTransactionStatusId": 0,
  "logPayerCountry": "<string>",
  "logPaymentProviderId": 0,
  "paymentMethodId": 0,
  "paymentProviderId": 0,
  "logCreateDate": "2023-11-07T05:31:56Z",
  "lastLog": {
    "id": 123,
    "paymentRequestId": 123,
    "transactionId": "<string>",
    "transactionStatusId": 0,
    "code": "<string>",
    "message": "<string>",
    "payerCountry": "<string>",
    "paymentProviderId": 0,
    "paymentMethodId": 0,
    "threeDs": true,
    "cardBin": "<string>",
    "cardLastDigits": "<string>",
    "device": "<string>",
    "browser": "<string>",
    "osName": "<string>",
    "isFallback": true,
    "isPendingFallback": true,
    "createDate": "2023-11-07T05:31:56Z"
  },
  "logs": [
    {
      "id": 123,
      "paymentRequestId": 123,
      "transactionId": "<string>",
      "transactionStatusId": 0,
      "code": "<string>",
      "message": "<string>",
      "payerCountry": "<string>",
      "paymentProviderId": 0,
      "paymentMethodId": 0,
      "threeDs": true,
      "cardBin": "<string>",
      "cardLastDigits": "<string>",
      "device": "<string>",
      "browser": "<string>",
      "osName": "<string>",
      "isFallback": true,
      "isPendingFallback": true,
      "createDate": "2023-11-07T05:31:56Z"
    }
  ],
  "ftdTypeId": 0,
  "routeRuleId": 123,
  "payerName": "<string>",
  "payerEmail": "<string>",
  "isFallback": true,
  "isPendingFallback": true,
  "isH2h": true,
  "isDelayedApproval": true,
  "isPremiumCardBin": true
}'
This response does not have an example.

​
Overview

The Payment Request API allows you to create payment requests that customers can complete using various payment methods. This is the standard integration method for most merchants.

​
Create Payment Request

Use this endpoint to create a new payment request with specified amount, currency, and callback URLs.

​
Key Features

  • Multiple Payment Methods: Support for credit cards, digital wallets, and alternative payment methods
  • Flexible Callbacks: Configure success, failure, and notification URLs
  • Reference Tracking: Include your own reference ID for order tracking
  • Multi-Currency: Support for various currencies with automatic conversion

​
Request Parameters

The payment request requires:
  • amount: Payment amount (required)
  • unit: Currency code (required)
  • referenceId: Your internal order/transaction ID (optional)
  • notifyUrl: Webhook URL for payment notifications (optional)
  • successUrl: Redirect URL for successful payments (optional)
  • failureUrl: Redirect URL for failed payments (optional)

​
Response

Upon successful creation, you’ll receive:
  • Payment request ID
  • Payment link for customer redirect
  • Status and tracking information

​
Next Steps

After creating a payment request:
  1. Redirect customer to the payment link
  2. Handle webhook notifications for status updates
  3. Process success/failure redirects
  4. Query payment status as needed

Query Parameters

​
send
boolean
​
accountType
enum<integer>
Available options:
0,
1,
2,
3
​
applicantId
string

Body

​
amount
number
required
Required range: x >= 0
​
unit
string
required
Maximum length: 20
​
id
integer
​
ownerId
integer
​
userId
integer | null
​
recipientName
string | null
​
paymentRequestStatusId
enum<integer>
Available options:
0,
1,
2,
3,
4,
5
​
transactionId
integer | null
​
transactionNumber
string | null
​
payerCountry
string | null
Maximum length: 100
​
referenceId
string | null
Maximum length: 100
​
notes
string | null
Maximum length: 512
​
link
string | null
​
createDate
string<date-time>
​
clientId
integer
​
clientName
string | null
​
clientEmail
string | null
​
clientAddress
string | null
​
clientPhone
string | null
​
clientMemberId
string | null
​
client
object
​
notifyUrl
string | null
Maximum length: 2048
​
successUrl
string | null
Maximum length: 2048
​
failureUrl
string | null
Maximum length: 2048
​
transactionStatusId
enum<integer>
Available options:
0,
1,
2,
3
​
targetAccountTypeId
enum<integer>
Available options:
0,
1,
2,
3
​
originDomain
string | null
​
chargedBack
boolean
​
feeAmount
number | null
​
grossAmount
number | null
​
netAmount
number | null
​
transactionCurrency
string | null
​
exchangeRate
number | null
​
cardBin
string | null
​
device
string | null
​
browser
string | null
​
osName
string | null
​
cardLastDigits
string | null
​
sumSubApplicantId
string | null
​
threeDs
boolean
​
logMessage
string | null
​
logTransactionId
string | null
​
logTransactionStatusId
enum<integer>
Available options:
0,
1,
2,
3
​
logPayerCountry
string | null
​
logPaymentProviderId
enum<integer>
Available options:
0,
11,
12,
13,
14,
15,
16,
17,
18,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
​
paymentMethodId
enum<integer>
Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
13,
14,
15,
16,
17,
18,
19,
20
​
paymentProviderId
enum<integer>
Available options:
0,
11,
12,
13,
14,
15,
16,
17,
18,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
​
logCreateDate
string<date-time>
​
lastLog
object
​
logs
object[] | null
​
ftdTypeId
enum<integer>
Available options:
0,
1,
2
​
routeRuleId
integer | null
​
payerName
string | null
​
payerEmail
string | null
​
isFallback
boolean
​
isPendingFallback
boolean
​
isH2h
boolean
​
isDelayedApproval
boolean
​
isPremiumCardBin
boolean

Response

OK

⌘I