Update a payment profile

put

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

Update the selected ACH/CC profile flags. For ACH, active is required; CC allows partial flag updates. The body field is active. Deactivating a profile may also deactivate associated recurring profiles and payment plans; affected tokens can be returned. Changing an account or card requires creating a new profile.

Request examples

ACH

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

PUT /api/v1/payment-profile/44444444-4444-4444-8444-444444444445?type=CC HTTP/1.1
Authorization: <PAYOLOGY_API_KEY>
Accept: application/json
Content-Type: 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
200	R0000	Ok	The request was processed successfully
400	R0002	Error	Field is not properly formatted
400	R0122	Error	A payment profile with an invalid routing number cannot be activated
400	R0124	Error	Cannot activate a Payment Profile which has failed verification.
400	R0202	Error	Organization is inactive
401	R0003	Error	Authentication token is invalid
403	R0003	Error	Access not allowed
404	R0005	Error	Payment Profile token is invalid
500	R0999	Error	Something went wrong

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payment_profile_token

uuid

required

Payment profile token in the selected payment service

Query Params

type

string

enum

required

Payment type.

Allowed:

Body Params

JSON request body. Required and conditional fields are defined by the schema. Named examples show supported request variants.

Update profile flags. For ACH, active is required. CC accepts optional active/default/bypass_webhook fields. Select the method with the type query parameter; the request body does not change account/card details.

active

boolean

Whether the resource is active and available for its supported operations.

default

boolean

Whether this is the customer default payment profile.

bypass_webhook

boolean

When true, suppress the webhook associated with this operation where supported. This does not change the payment processing outcome.

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 flags updated.

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.

413Proxy JSON body exceeds the configured 1 MiB limit; base64 images count toward that limit.

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.