Get a payment plan by reference ID

get

https://test-api.payology.io/customer-vault/api/v1/payment-plan/{reference_id}/{customer_token}

Look up an existing schedule using the partner reference and customer token. Use this to reconcile an uncertain create response.

This request has no JSON body. Use the path/query examples below.

Request examples

ByReference

GET /customer-vault/api/v1/payment-plan/plan-1001/22222222-2222-4222-8222-222222222222 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json

Result codes in the response examples

HTTP status and result code are operation-specific. Field-validation messages can include the affected field name.

HTTP	Code	Result	Meaning
400	R0002	Error	Field is not properly formatted
401	R0003	Error	Authentication token is invalid
403	R0003	Error	Access not allowed
404	R0010	Error	Payment Plan token is invalid
500	R0999	Error	Something went wrong

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

default

Other infrastructure or forwarded downstream response. HTTP status and body must be preserved; do not assume every error has a Payology R-code. No fixed payload is guaranteed.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Matching schedule.

400Invalid fields, selector, or business rule. Consult the individual example code.

401Authentication failed. Some services also use 401 for organization access denial. Gateway bodies can differ.

403Permission or organization access denied; the gateway can reject the request before it reaches the service.

404Requested resource or lookup reference was not found.

429Gateway throttling or quota. Exact quota, retry headers and deployed body were not verified. This is a platform possibility, not an observed Payology response.

500Unhandled service failure. Gateway configuration/authorizer failures can also return 500.

504Gateway integration timeout or failure. The service may still have committed a create request. This is a platform possibility, not an observed Payology response.