Creating a Payment
Creating a Payment
POST https://api.payouter.com/payments
Headers
Content-Type
application/json
Signature
Signed request body
Merchant
Merchant ID
Body
amount
string
true
Amount to be paid. If the amount includes pennies, use a ‘.’ as a decimal separator. Example: 10.28
order_id
string
true
Order identifier in your system. Must be a string consisting of letters, digits, underscores, and hyphens. No spaces or special characters allowed.
order_id must be unique among seller’s invoices
upi_id
string
false
Extra parameter when creating an invoice with payment method UPI_INTENT If not provided, the user will be prompted to enter it on the payment terminal page
fingerprint
string
true
Unique user identifier
url_success
string
false
After successful payment, the user can click a button on the payment form to return to this URL
url_error
string
false
In case of any error or cancellation of the created invoice, the user can click a button on the payment form to return to this URL
url_callback
string
false
URL where the webhook will be sent
additional_data
string
false
Additional information for you (not shown to the client)
Response
{
type: string, // Payment type PayIn/PayOut
uuid: string, // Unique identifier in our system
order_id: string, // Your order ID sent during creation
lifetime: number | null, // Unix timestamp for expiration date/time
amount: string, // Fiat amount of the created order
payment_link: string | null, // Link to the payment terminal
fact_amount: string | null, // Fiat amount of actual execution of the order
balance_change: string | null, // Amount credited to the platform account
commission: string | null, // Amount taken as commission
is_test: boolean, // Whether the order is a test order
status: string, // Current order status
payment_type: string, // Payment method code
refer: string | null, // Recipient details
recipient_name: string | null, // Recipient full name
bank: string | null, // Recipient bank code
currency: string, // Currency code
additional_data: string | null, // Extra info sent at order creation
convert: {
to_currency: string, // Currency or cryptocurrency code for credited amount
rate: string | null // Conversion rate
},
extra: null, // Additional invoice information
created_at: string, // ISO-8601 order creation date/time
} {
type: string, // Payment type PayIn/PayOut
uuid: string, // Unique identifier in our system
order_id: string, // Your order ID sent during creation
lifetime: number | null, // Unix timestamp for expiration date/time
amount: string, // Fiat amount of the created order
payment_link: string | null, // Link to the payment terminal
fact_amount: string | null, // Fiat amount of actual execution of the order
balance_change: string | null, // Amount credited to the platform account
commission: string | null, // Amount taken as commission
is_test: boolean, // Whether the order is a test order
status: string, // Current order status
payment_type: string, // Payment method code
refer: string | null, // Recipient details
recipient_name: string | null, // Recipient full name
bank: string | null, // Recipient bank code
currency: string, // Currency code
additional_data: string | null, // Extra info sent at order creation
convert: {
to_currency: string, // Currency or cryptocurrency code for credited amount
rate: string | null // Conversion rate
},
extra: { // Additional invoice information
paymentLink: string // Deeplink for payment
},
created_at: string, // ISO-8601 order creation date/time
} {
type: string, // Payment type PayIn/PayOut
uuid: string, // Unique identifier in our system
order_id: string, // Your order ID sent during creation
lifetime: number | null, // Unix timestamp for expiration date/time
amount: string, // Fiat amount of the created order
payment_link: string | null, // Link to the payment terminal
fact_amount: string | null, // Fiat amount of actual execution of the order
balance_change: string | null, // Amount credited to the platform account
commission: string | null, // Amount taken as commission
is_test: boolean, // Whether the order is a test order
status: string, // Current order status
payment_type: string, // Payment method code
refer: string | null, // Recipient details
recipient_name: string | null, // Recipient full name
bank: string | null, // Recipient bank code
currency: string, // Currency code
additional_data: string | null, // Extra info sent at order creation
convert: {
to_currency: string, // Currency or cryptocurrency code for credited amount
rate: string | null // Conversion rate
},
extra: { // Additional invoice information
"googlePayLink": string, // Deeplink for payment
"paytmLink": string, // Deeplink for payment
"phonePeLink": string, // Deeplink for payment
"upiLink": string // Deeplink for payment
},
created_at: string, // ISO-8601 order creation date/time
} {
type: string, // Payment type PayIn/PayOut
uuid: string, // Unique identifier in our system
order_id: string, // Your order ID sent during creation
lifetime: number | null, // Unix timestamp for expiration date/time
amount: string, // Fiat amount of the created order
payment_link: string | null, // Link to the payment terminal
fact_amount: string | null, // Fiat amount of actual execution of the order
balance_change: string | null, // Amount credited to the platform account
commission: string | null, // Amount taken as commission
is_test: boolean, // Whether the order is a test order
status: string, // Current order status
payment_type: string, // Payment method code
refer: string | null, // Recipient details
recipient_name: string | null, // Recipient full name
bank: string | null, // Recipient bank code
currency: string, // Currency code
additional_data: string | null, // Extra info sent at order creation
convert: {
to_currency: string, // Currency or cryptocurrency code for credited amount
rate: string | null // Conversion rate
},
extra: { // Additional invoice information
bankName: string, // Name of the bank
ifscCode: string // IFSC code
},
created_at: string, // ISO-8601 order creation date/time
}{
"data": null,
"error": {
"status": 400,
"name": "BadRequestError",
"message": "Bad request, Order already Exist",
"details": {}
}
}Last updated