Skip to main content
POST
/
payment_records
/
{payment_record_id}
/
start_processing
Start processing a payment record
curl --request POST \
  --url https://api.sandbox.monite.com/v1/payment_records/{payment_record_id}/start_processing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "payment_intent_status": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "currency": "AED",
  "history": [
    {
      "status": "created",
      "timestamp": "2023-11-07T05:31:56Z",
      "entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "is_external": true,
  "object": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "new_status": "<string>",
    "old_status": "<string>",
    "type": "receivable"
  },
  "entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "overpaid_amount": 0,
  "paid_at": "2023-11-07T05:31:56Z",
  "payment_intent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_intent_status": "<string>",
  "payment_method": "<string>",
  "planned_payment_date": "2023-12-25",
  "status": "succeeded"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
payment_record_id
string<uuid>
required

Body

application/json
​
payment_intent_status
string

Raw status string of the external payment intent.

Response

Successful Response

​
id
string<uuid>
required
​
amount
integer
required

Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents).

​
currency
enum<string>
required

Currency code (ISO 4217) indicating the currency in which the payment was made.

Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
SVC,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
​
history
object[]
required

History of the payment record.

​
is_external
boolean
required
​
object
object
required
​
entity_user_id
string<uuid>

ID of the user associated with the payment, if applicable.

​
overpaid_amount
integer
default:0

Filled in a case, if payment amount is more, than total_amount

Required range: x >= 0
​
paid_at
string<date-time>

Timestamp marking when the payment was executed. Null if payment hasn't occurred yet.

​
payment_intent_id
string<uuid>

Identifier for an payment intent.

​
payment_intent_status
string

Raw status string of the external payment intent.

​
payment_method
string

Payment method used or planned for the transaction.

​
planned_payment_date
string<date>

Scheduled date for future payments, required when the payment is planned but not yet executed.

​
status
string
default:succeeded

The current status of the payment record. Possible values: created, processing, succeeded, canceled.