Get a payment profile

get

https://test-api.payology.io/api/v1/payment-profile

Retrieve an ACH or CC profile. Supply type and exactly one of payment_profile_token or reference_id. ACH uses payment_profile_status for verification status; CC uses status. Sensitive account data is masked. ACH verification_result can be an empty object when verification has not run.

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

Request examples

ACH

GET /api/v1/payment-profile?type=ACH&payment_profile_token=44444444-4444-4444-8444-444444444444 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json

GET /api/v1/payment-profile?type=CC&payment_profile_token=44444444-4444-4444-8444-444444444445 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json

ACHByReference

GET /api/v1/payment-profile?type=ACH&reference_id=profile-ach-1001 HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json

CCByReference

GET /api/v1/payment-profile?type=CC&reference_id=profile-cc-1001 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	R0005	Error	Payment Profile token is invalid
404	R0124	Error	Reference ID is invalid
404	R0127	Error	reference_id 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.

200Profile details, with sensitive account values masked.

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.

502Proxy could not obtain an HTTP response from the selected payment service.

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