Skip to main content
POST
/
payment-requests
cURL
curl --request POST \
  --url https://apay.yonobi.io/payment-requests \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "amount": 1,
  "unit": "<string>",
  "id": 123,
  "ownerId": 123,
  "userId": 123,
  "recipientName": "<string>",
  "paymentRequestStatusId": 0,
  "transactionId": 123,
  "transactionNumber": "<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": {
    "name": "<string>",
    "email": "[email protected]",
    "id": 123,
    "ownerId": 123,
    "userId": 123,
    "ownerName": "<string>",
    "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
}
'
{}

Query Parameters

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

Body

amount
number<double>
required
Required range: x >= 0
unit
string
required
Maximum string length: 20
id
integer<int64>
ownerId
integer<int64>
userId
integer<int64> | null
recipientName
string | null
paymentRequestStatusId
enum<integer>
Available options:
0,
1,
2,
3,
4,
5
transactionId
integer<int64> | null
transactionNumber
string | null
payerCountry
string | null
Maximum string length: 100
referenceId
string | null
Maximum string length: 100
notes
string | null
Maximum string length: 512
createDate
string<date-time>
clientId
integer<int64>
clientName
string | null
clientEmail
string | null
clientAddress
string | null
clientPhone
string | null
clientMemberId
string | null
client
object
notifyUrl
string | null
Maximum string length: 2048
successUrl
string | null
Maximum string length: 2048
failureUrl
string | null
Maximum string 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<double> | null
grossAmount
number<double> | null
netAmount
number<double> | null
transactionCurrency
string | null
exchangeRate
number<double> | 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<int64> | null
payerName
string | null
payerEmail
string | null
isFallback
boolean
isPendingFallback
boolean
isH2h
boolean
isDelayedApproval
boolean
isPremiumCardBin
boolean

Response

OK