/api/v1/payments

post https://engine-sandbox.paypear.io/api/v1/payments

Payment request, used for DEPOSITS, WITHDRAWALS and REFUNDS

Body Params

Payment Request - Request to initiate a payment

referenceId

string

length ≤ 256

Reference assigned by Merchant. Will not go outside the system. Will be sent unchanged in the PaymentResponse.

paymentType

string

required

Payment Type

paymentMethod

string

Payment Method

amount

number

1e-18 to 999999.99

Payment amount

currency

string

required

Payment currency

parentPaymentId

string

length ≤ 32

Id of initial deposit for refunds, Id of initial recurring payment for subsequent payments

description

string

length ≤ 512

Description of the transaction shown to the Customer. Can be sent outside the system.

card

object

You must be PCI DSS compliant to collect card data on your side. If you are not certified, do not add this field to your request and we will collect the data on our page.

customer

object

billingAddress

object

Customer's billing address

returnUrl

string

length ≤ 256

URL to redirect Customer after processing

webhookUrl

string

Url to receive payment status notifications

startRecurring

boolean

Send 'true' if you want this payment to initiate recurring chain. Default is 'false'.

recurringToken

string

To continue recurring chain, send a token from a previously initiated recurring payment.

subscription

object

Subscription to bill customers at regular intervals. Used only with 'startRecurring=true'.

additionalParameters

object

Additional parameters required by some payment providers. Contact support for more information.

Responses

Response body

object

timestamp

string

status

integer

HTTP status code

result

object

string

length ≤ 32

Payment Id

referenceId

string

length ≤ 256

referenceId from payment request

paymentType

string

Payment Type

DEPOSIT WITHDRAWAL REFUND

state

string

Payment State

CHECKOUT PENDING CANCELLED DECLINED COMPLETED

description

string

length ≤ 512

Description of the transaction

parentPaymentId

string

length ≤ 32

Initial transaction Id from payment request

paymentMethod

string

Payment Method

BASIC_CARD CRYPTO FLEXEPIN MACROPAY SKRILL PAYRETAILERS LOCALPAYMENT MONNET PAYPAL NETELLER TRUSTPAYMENTS PAYMAXIS GATE8TRANSACT TINK B2BINPAY CLICK MONETIX PERFECTMONEY VOLT KESSPAY BILLLINE NGENIUS ASTROPAY ALYCEPAY PIX BOLETO UPI PAYTM NETBANKING FINRAX SPOYNT XINPAY OMNIMATRIX DPOPAY EXTERNAL_HPP XANPAY INRPAY ARI10 SOFORT GIROPAY PAYSAFECARD PAYSAFECASH OPEN_BANKING KLARNA SPEI PAYCASH RAPIPAGO PAGOFACIL RAPIDTRANSFER MOBILE_MONEY INTERAC INTERAC_ETO INTERAC_RTO INTERAC_ACH PICPAY MOLLIE TED ZIPAY PSE EFECTY BANKTRANSFER PEC OXXO WEBPAY PAGOEFECTIVO MIFINITY PAYPORT JETONCASH JETONWALLET NEOSURF NODA NODA_REVOLUT ALFAKIT PAYFUN EMANAT M10 RUBPAY MONERCHY MUCHBETTER YAPILY INAI IMPS RTGS PAYID ZOTAPAY SBP P2P_CARD P2P_IBAN P2P_SBP P2P_MOBILE PUSH GATEIQ VIETTEL ZALO QR CUP CODI PAY2PLAY BKASH NAGAD ROCKET VIRTUAL_ACCOUNT MULTIBANCO BLIK MBWAY P24 MISTERCASH MACH KHIPU NEFT STICPAY SBERPAY MOBILE_COMMERCE BINANCE_PAY MPAY CHEK KLAP_EFECTIVO KLAP_TRANSFERENCIA PAGO46 HITES SERVIFACIL OPENPAYD FAWRY EPS IDEAL TRUSTLY USSD MPESA ENAIRA ONEVOUCHER BANCONTACT SWISH EFT GCASH PAYMAYA PAGO_MOVIL PAGO_MOVIL_INST BIOPAGO CASH VOUCHERRY SOFT2PAY APPLEPAY GOOGLEPAY BRITE VOUCHSTAR REVOLUT ONLINE_BANKING PROMPTPAY TRUEMONEY MOMOPAY_VN MOMOPAY_RW VNPAY_QR N26 WISE PAYDO_WALLET PAPARA PAYPAY PARAZULA PAYFIX PHONEPE CIP BASIC_CARD_HPP PAYOUT_SEPA_BATCH PAYOUT_NONSEPA_REQUEST

paymentMethodDetails

object

amount

number

1e-18 to 999999.99

Amount sent to the payment provider

currency

string

Currency sent to the payment provider

customerAmount

number

Amount from payment request. Filled only if the request currency differs from the currency sent to the payment provider.

customerCurrency

string

Currency from payment request. Filled only if it differs from the currency sent to the payment provider.

redirectUrl

string

length ≤ 256

URL to redirect the customer

errorCode

string

Check 'Error Codes' section for details

errorMessage

string

Check 'Error Codes' section for details

externalResultCode

string

Result code from external provider

customer

object

billingAddress

object

Customer's billing address

startRecurring

boolean

Indicates whether this payment has started a recurring chain

recurringToken

string

Token that can be used to continue the recurring chain

terminalName

string

The name of the provider that was used to process this payment

externalFeeAmount

number

Provider fee. Filled only if supported by the provider.

externalFeeCurrency

string

Provider fee currency. Filled only if supported by the provider.

200Payment response

400Invalid input

401Invalid credentials