Get Pay Plan

Return details of a pay plan.

SecurityMarketplace API Key | Merchant Secret Token | Admin JWT | Marketplace JWT | Merchant JWT

Request

path Parameters

payPlanId

required

string

Responses

200

400

401

403

404

405

406

409

422

429

500

503

get/payplans/{payPlanId}

Request samples

Curl
JavaScript

Response samples

application/json

{"payPlanId": "plan_Z2icv3UXMhzzOEVj",
"merchantId": "mcht_Z2icvnUXMhzzOEVh",
"customerId": "cust_Z2icvnUXMhzzOEVi",
"state": "Created",
"amount": {"minorCurrencyUnits": 0,
"currency": "AUD"
},
"surchargeAmount": 0,
"platformFee": 0,
"taxAmount": 0,
"payPlanVariant": "payplan_fortnight_25_25_25_25",
"nextInstalmentDate": "2019-08-24T14:15:22Z",
"nextInstalment": 3,
"planAmountOutstanding": 0,
"paymentSourceType": "Card",
"merchantOrderId": "ordr_Z2icv3UXMhzzOEVl",
"transactionId": "tran_Z2icv3UXMhzzOEVk",
"charges": [{"chargeId": "chrg_Z2icv3UXMhzzOEVm",
"amount": 0,
"isSuccess": true,
"instalmentNumber": 0,
"instalmentCharge": true,
"createdAt": "2019-08-24T14:15:22Z"
}
],
"refunds": [{"refundId": "rfnd_Z2icwHUXMhzzOEV0",
"amount": 0,
"createdAt": "2019-08-24T14:15:22Z"
}
],
"isRefunded": true,
"isOverdue": true,
"overdueAmount": 0,
"overdueAt": "2019-08-24T14:15:22Z",
"bankTransferDetails": {"reference": "string",
"bankAccountNumber": "string",
"bankAccountBsb": "string",
"payId": "string",
"metadata": {"property1": "string",
"property2": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}