POST
/
api
/
payments
/
payments
Create a payment
curl --request POST \
  --url http://localhost:55001/api/payments/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reference": "<string>",
  "connectorID": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "amount": 100,
  "type": "PAY-IN",
  "status": "PENDING",
  "scheme": "unknown",
  "asset": "USD",
  "sourceAccountID": "<string>",
  "destinationAccountID": "<string>"
}'
{
  "data": {
    "id": "XXX",
    "reference": "<string>",
    "sourceAccountID": "<string>",
    "destinationAccountID": "<string>",
    "connectorID": "<string>",
    "provider": "STRIPE",
    "type": "PAY-IN",
    "status": "PENDING",
    "initialAmount": 100,
    "amount": 100,
    "scheme": "unknown",
    "asset": "USD",
    "createdAt": "2023-11-07T05:31:56Z",
    "raw": {},
    "adjustments": [
      {
        "reference": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "status": "PENDING",
        "amount": 100,
        "raw": {}
      }
    ],
    "metadata": {}
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
reference
string
required
connectorID
string
required
createdAt
string<date-time>
required
amount
integer
required
Required range: x >= 0
Example:

100

type
enum<string>
required
Available options:
PAY-IN,
PAYOUT,
TRANSFER,
OTHER
status
enum<string>
required
Available options:
PENDING,
SUCCEEDED,
CANCELLED,
FAILED,
EXPIRED,
REFUNDED,
REFUNDED_FAILURE,
DISPUTE,
DISPUTE_WON,
DISPUTE_LOST,
OTHER
scheme
enum<string>
required
Available options:
unknown,
other,
visa,
mastercard,
amex,
diners,
discover,
jcb,
unionpay,
alipay,
cup,
sepa debit,
sepa credit,
sepa,
apple pay,
google pay,
doku,
dragonpay,
maestro,
molpay,
a2a,
ach debit,
ach,
rtp
asset
string
required
Example:

"USD"

sourceAccountID
string
destinationAccountID
string

Response

OK

data
object
required