Retrieve payment
Retrieves the details of an existing payment.
Required permissions:
- payment:basic:read
- plan:basic:read
- access_pass:basic:read
- member:email:read
- member:basic:read
- member:phone:read
- promo_code:basic:read
- shipment:basic:read
- payment:dispute:read
- payment:resolution_center_case:read
Path parameters
The unique identifier of the payment.
Response
A successful response
Example response
{
"amount_after_fees": 6.9,
"application_fee": {
"amount": 6.9,
"amount_captured": 6.9,
"amount_refunded": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"id": "apfee_xxxxxxxxxxxx"
},
"card_exp_month": 6,
"card_exp_year": 2027,
"card_last4": "4242",
"checkout_configuration_id": "ch_xxxxxxxxxxxxxxx",
"company": {
"id": "biz_xxxxxxxxxxxxxx"
},
"created_at": "2023-12-01T05:00:00.401Z",
"dispute_alerted_at": "2023-12-01T05:00:00.401Z",
"disputes": [
{
"amount": 6.9,
"id": "dspt_xxxxxxxxxxxxx",
"needs_response_by": "2023-12-01T05:00:00.401Z",
"notes": "Customer used the product for 3 months before disputing.",
"reason": "Product Not Received"
}
],
"fees": [
{
"amount": 6.9
}
],
"financing_installments_count": 42,
"financing_transactions": [
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"id": "ptx_xxxxxxxxxxxxxx"
}
],
"id": "pay_xxxxxxxxxxxxxx",
"last_payment_attempt": "2023-12-01T05:00:00.401Z",
"membership": {
"id": "mem_xxxxxxxxxxxxxx"
},
"next_payment_attempt": "2023-12-01T05:00:00.401Z",
"paid_at": "2023-12-01T05:00:00.401Z",
"payment_instrument": {
"installment_count": 42
},
"payment_method": {
"card": {
"exp_month": 42,
"exp_year": 42,
"last4": "4242"
},
"created_at": "2023-12-01T05:00:00.401Z",
"id": "payt_xxxxxxxxxxxxx"
},
"payments_failed": 42,
"plan": {
"id": "plan_xxxxxxxxxxxxx"
},
"product": {
"id": "prod_xxxxxxxxxxxxx",
"route": "pickaxe-analytics",
"title": "Pickaxe Analytics"
},
"promo_code": {
"amount_off": 6.9,
"id": "promo_xxxxxxxxxxxx",
"number_of_intervals": 42
},
"refunded_amount": 6.9,
"refunded_at": "2023-12-01T05:00:00.401Z",
"refunds": [
{
"amount": 6.9,
"created_at": "2023-12-01T05:00:00.401Z",
"id": "rf_xxxxxxxxxxxxxxx"
}
],
"resolutions": [
{
"due_date": "2023-12-01T05:00:00.401Z",
"id": "reso_xxxxxxxxxxxxx"
}
],
"risk_score": 42,
"settlement_amount": 6.9,
"settlement_exchange_rate": 6.9,
"settlement_time_at": "2023-12-01T05:00:00.401Z",
"shipment": {
"carrier": "usps",
"id": "ship_xxxxxxxxxxxxx",
"tracking_number": "9400111899223456789012",
"tracking_url": "https://track.aftership.com/9400111899223456789012"
},
"subtotal": 6.9,
"tax_amount": 6.9,
"tax_refunded_amount": 6.9,
"total": 6.9,
"updated_at": "2023-12-01T05:00:00.401Z",
"usd_total": 6.9,
"user": {
"email": "john.doe@example.com",
"id": "user_xxxxxxxxxxxxx",
"name": "John Doe",
"username": "johndoe42"
},
"client_secret": "pay_xxxxxxxxxxxxxx_secret_v1_xxxx"
}Changes
Changed in 14 of the 41 revisions of this API.632214
- ○
added the required property
allOf[Payment]/feesto the response with the200statusresponse-required-property-added
- ○
- ●
added the new
flex_payenum value to theallOf[Payment]/payment_method/payment_method_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
flex_payenum value to theallOf[Payment]/payment_method_type/oneOf[PaymentMethodTypes]/response property for the response status200response-property-enum-value-added
- ●
added the new
gcashenum value to theallOf[Payment]/payment_method/payment_method_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
gcashenum value to theallOf[Payment]/payment_method_type/oneOf[PaymentMethodTypes]/response property for the response status200response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
authorizedenum value to theallOf[Payment]/status/oneOf[ReceiptStatus]/response property for the response status200response-property-enum-value-added
- ●
added the new
requires_captureenum value to theallOf[Payment]/substatusresponse property for the response status200response-property-enum-value-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
accelenum value to theallOf[Payment]/card_brand/oneOf[CardBrands]/response property for the response status200response-property-enum-value-added
- ●
added the new
accelenum value to theallOf[Payment]/payment_method/card/brand/oneOf[CardBrands]/response property for the response status200response-property-enum-value-added
- ●
added the new
culianceenum value to theallOf[Payment]/card_brand/oneOf[CardBrands]/response property for the response status200response-property-enum-value-added
- ●
added the new
culianceenum value to theallOf[Payment]/payment_method/card/brand/oneOf[CardBrands]/response property for the response status200response-property-enum-value-added
- ●
added the new
nyceenum value to theallOf[Payment]/card_brand/oneOf[CardBrands]/response property for the response status200response-property-enum-value-added
- ●
added the new
nyceenum value to theallOf[Payment]/payment_method/card/brand/oneOf[CardBrands]/response property for the response status200response-property-enum-value-added
- ●
added the new
pulseenum value to theallOf[Payment]/card_brand/oneOf[CardBrands]/response property for the response status200response-property-enum-value-added
- ●
added the new
pulseenum value to theallOf[Payment]/payment_method/card/brand/oneOf[CardBrands]/response property for the response status200response-property-enum-value-added
- ●
added the new
starenum value to theallOf[Payment]/card_brand/oneOf[CardBrands]/response property for the response status200response-property-enum-value-added
- ●
added the new
starenum value to theallOf[Payment]/payment_method/card/brand/oneOf[CardBrands]/response property for the response status200response-property-enum-value-added
This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
the response's body type/format changed from
object/to/for status200response-body-type-changed
- ▲
removed the required property
amount_after_feesfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
application_feefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
auto_refundedfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
billing_addressfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
billing_reasonfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
card_brandfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
card_exp_monthfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
card_exp_yearfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
card_last4from the response with the200statusresponse-required-property-removed
- ▲
removed the required property
checkout_configuration_idfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
companyfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
created_atfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
currencyfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
customer_phonefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
decline_codefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
dispute_alerted_atfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
disputesfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
failure_messagefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
financing_installments_countfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
financing_transactionsfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
idfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
last_payment_attemptfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
memberfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
membershipfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
metadatafrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
needs_trackingfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
next_payment_attemptfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
paid_atfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
payment_instrumentfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
payment_methodfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
payment_method_typefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
payments_failedfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
planfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
productfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
promo_codefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
refundablefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
refunded_amountfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
refunded_atfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
refundsfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
resolutionsfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
retryablefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
risk_scorefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
risk_signalsfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
settlement_amountfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
settlement_currencyfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
settlement_exchange_ratefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
settlement_time_atfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
shipmentfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
shipping_addressfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
statusfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
substatusfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
subtotalfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
tax_amountfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
tax_behaviorfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
tax_refunded_amountfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
three_ds_verifiedfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
totalfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
updated_atfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
usd_totalfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
userfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
verification_checksfrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
voidablefrom the response with the200statusresponse-required-property-removed
- ○
added
Paymentsubschema #2to the response bodyallOflist for the response status200response-body-all-of-added
- ▲
- ○
added the required property
payment_method/card/fingerprintto the response with the200statusresponse-required-property-added
- ○
- ●
added the new
modoenum value to thepayment_method/payment_method_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
modoenum value to thepayment_method_type/oneOf[PaymentMethodTypes]/response property for the response status200response-property-enum-value-added
- ●
added the new
rapipagoenum value to thepayment_method/payment_method_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
rapipagoenum value to thepayment_method_type/oneOf[PaymentMethodTypes]/response property for the response status200response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ○
added the required property
payment_instrumentto the response with the200statusresponse-required-property-added
- ○
- ○
added the required property
verification_checksto the response with the200statusresponse-required-property-added
- ○
- ○
added the required property
card_exp_monthto the response with the200statusresponse-required-property-added
- ○
added the required property
card_exp_yearto the response with the200statusresponse-required-property-added
- ○
added the required property
decline_codeto the response with the200statusresponse-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○