Create Payment Request

post

https://prod.api.getborderless.com/payments/paymentRequest

Introduction

This endpoint allows you to create payment request. Recipient of this request is not being deducted until he accepts payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

handle

string

required

The borderless™ username (@handle) of the customer you would like to request payment from, without the “@” symbol.

amount

number

required

Non-negative amount to create payment request.

description

string

required

A customized message describing the nature and reason for the payment.

popCode

string

required

Purpose Of Payment (known as “POP”) code that denotes the reason for the payment required for compliance.

exchangeCurrencyBasis

string

enum

Exchange Currency Basis defines in whos currency (BENEFICIARY or PAYER) payment will be executed. Possible values are BENEFICIARY and PAYER. Default value is BENEFICIARY.

Allowed:

beneAcceptedFees

boolean

This field indicates who pays the transaction fee. The default value is set to true which means the recipient (user who requested) pays the fee. If set to false - payer will pay the fees.

Headers

Client-Id

string

Unique identifier of Child Account (required only for Partner).

Responses

404

Server Error

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Error

401Authentication Error