Skip to main content
POST
Finalize a Payment

Authorizations

Authorization
string
header
required

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

Path Parameters

payment_id
string
required

Response

Successful response

amount
integer
required

The gross amount (less any fees) in the currency's smallest unit, e.g. $10 USD would be represented as 1000. amount must be >= 0

currency
enum<string>
required

The ISO-4217 currency code of the payment.

Available options:
ADP,
AED,
AFA,
AFN,
ALK,
ALL,
AMD,
ANG,
AOA,
AOK,
AON,
AOR,
ARA,
ARL,
ARM,
ARP,
ARS,
ATS,
AUD,
AWG,
AZM,
AZN,
BAD,
BAM,
BAN,
BBD,
BDT,
BEC,
BEF,
BEL,
BGL,
BGM,
BGN,
BGO,
BHD,
BIF,
BMD,
BND,
BOB,
BOL,
BOP,
BOV,
BRB,
BRC,
BRE,
BRL,
BRN,
BRR,
BRZ,
BSD,
BTN,
BUK,
BWP,
BYB,
BYN,
BYR,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLE,
CLF,
CLP,
CNH,
CNX,
CNY,
COP,
COU,
CRC,
CSD,
CSK,
CUC,
CUP,
CVE,
CYP,
CZK,
DDM,
DEM,
DJF,
DKK,
DOP,
DZD,
ECS,
ECV,
EEK,
EGP,
ERN,
ESA,
ESB,
ESP,
ETB,
EUR,
FIM,
FJD,
FKP,
FRF,
GBP,
GEK,
GEL,
GHC,
GHS,
GIP,
GMD,
GNF,
GNS,
GQE,
GRD,
GTQ,
GWE,
GWP,
GYD,
HKD,
HNL,
HRD,
HRK,
HTG,
HUF,
IDR,
IEP,
ILP,
ILR,
ILS,
INR,
IQD,
IRR,
ISJ,
ISK,
ITL,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRH,
KRO,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LTT,
LUC,
LUF,
LUL,
LVL,
LVR,
LYD,
MAD,
MAF,
MCF,
MDC,
MDL,
MGA,
MGF,
MKD,
MKN,
MLF,
MMK,
MNT,
MOP,
MRO,
MRU,
MTL,
MTP,
MUR,
MVP,
MVR,
MWK,
MXN,
MXP,
MXV,
MYR,
MZE,
MZM,
MZN,
NAD,
NGN,
NIC,
NIO,
NLG,
NOK,
NPR,
NZD,
OMR,
PAB,
PEI,
PEN,
PES,
PGK,
PHP,
PKR,
PLN,
PLZ,
PTE,
PYG,
QAR,
RHD,
ROL,
RON,
RSD,
RUB,
RUR,
RWF,
SAR,
SBD,
SCR,
SDD,
SDG,
SDP,
SEK,
SGD,
SHP,
SIT,
SKK,
SLE,
SLL,
SOS,
SRD,
SRG,
SSP,
STD,
STN,
SUR,
SVC,
SYP,
SZL,
THB,
TJR,
TJS,
TMM,
TMT,
TND,
TOP,
TPE,
TRL,
TRY,
TTD,
TWD,
TZS,
UAH,
UAK,
UGS,
UGX,
USD,
USN,
USS,
UYI,
UYP,
UYU,
UYW,
UZS,
VEB,
VED,
VEF,
VES,
VND,
VNN,
VUV,
WST,
XAF,
XAG,
XAU,
XBA,
XBB,
XBC,
XBD,
XCD,
XCG,
XDR,
XEU,
XFO,
XFU,
XOF,
XPD,
XPF,
XPT,
XRE,
XSU,
XTS,
XUA,
XXX,
YDD,
YER,
YUD,
YUM,
YUN,
YUR,
ZAL,
ZAR,
ZMK,
ZMW,
ZRN,
ZRZ,
ZWD,
ZWL,
ZWR
Maximum string length: 3
object
string
required
partner_id
string
required

The id of the partner that made this payment.

Maximum string length: 32
status
enum<string>
required

The status of the payment.

Available options:
pending_match,
pending_approval,
approved,
finalized
Maximum string length: 16
timestamp
string<date-time>
required

If posted, the time the payment posted. Otherwise the time the payment is expected or initiated.

id
string
Maximum string length: 32
agent_confidence_reason
string | null

The justification for the agent's confidence score.

agent_confidence_score
integer | null

The confidence score of the result on a scale of 0-100, where 0 indicates no confidence in the accuracy of the result and 100 indicates full confidence in the accuracy of the result.

agent_error_code
string | null

The code for why an error occurred when processing the statement.

agent_uncertainties
string[]

A list of uncertainties we have regarding the result.

allocations
object[]
amount_refunded
integer

The amount refunded in the currency's smallest unit, e.g. $10 USD would be represented as 1000. amount must be >= 0

bank_transaction
object
bank_transaction_id
string | null

The bank_transaction this payment was reconciled to.

Maximum string length: 32
billing_email
string | null

The billing email address of the payment

Maximum string length: 255
created_at
string<date-time>
currency_rate
integer | null
custom_fields
any
description
string | null

The memo, remark, or description associated with the payment/transaction.

expected_at
string<date-time> | null

When the payment is expected to post.

finix_transfer_id
string | null
Maximum string length: 32
initiated_at
string<date-time> | null

The time at which the payment was initiated.

last_exported_at
string<date-time> | null

The time at which the payment was last exported.

last_synced_at
string<date-time> | null
linked_integration_id
string | null

The linked_integration this payment was originated from, if any.

Maximum string length: 32
modified_at
string<date-time> | null
partner
object
payment_method
enum<string> | null

The payment method used to make the payment.

Available options:
ach,
alipay,
au_becs,
bacs,
card,
cash,
check,
ideal,
interac,
eft,
eps,
giropay,
klarna,
sepa,
wechat,
wire,
other,
null
Maximum string length: 7
receipt_url
string | null
reference_number
string | null

A unique identifier for the payment.

remittance
object
remittance_id
string | null

The id of the remittance this payment originated from.

Maximum string length: 32
remote_created_at
string<date-time> | null

When the third party's entry was created.

remote_id
string | null

The unique identifier of the payment in the system it originated from, e.g. a stripe charge

remote_metadata
unknown
remote_modified_at
string<date-time> | null

When the third party's entry was updated.

statement_descriptor
string | null

The memo, remark, or description associated with the payment/transaction.

stripe_session_id
string | null
Maximum string length: 32
sync_status
enum<string>

The sync status for this entity.

Available options:
partial,
syncing,
synced,
failed
Maximum string length: 7
transaction_match_approved_at
string<date-time> | null

The time at which the transaction match was approved.

transaction_match_approver_id
string | null
Maximum string length: 32