The Credit a Payment Method endpoint allows you to issue a credit directly to a payment method without a prior transaction. This is used to send funds to a customer's card or bank account.
This operation is only available for merchants whose gateways support the "general credit" feature. It is not commonly recommended due to increased risk and compliance considerations.
Usage Scenarios
Rebates and Promotions: Issuing funds to a customer as part of a rebate program.
Customer Service Gestures: Providing goodwill credits to resolve customer service issues.
Payouts: Sending funds to customers or partners.
Response Structure
| Code | Response | Reason |
|---|---|---|
| 200 | Success | Returns a transaction object indicating the credit was processed, including transaction ID, type, status, amount, currency, payment method ID, creation timestamp, and any metadata provided. |
| 400 | Bad Request | The merchant's gateway does not support general credits. |
| 422 | Unprocessable Entity | Validation errors occurred. |
Detailed Parameter Descriptions
payment_method_id: Must correspond to an existing payment method capable of receiving credits.
total: Specify the amount accurately to prevent overpaying or underpaying.
meta: Include any additional information or descriptors relevant to the credit.
Usage Notes
Gateway Support
Verify that the merchant's gateway supports general credits before attempting this operation.
Alternatives
Where possible, issue refunds against existing transactions using the void-or-refund endpoint.
Compliance
Be aware of anti-money laundering (AML) regulations and ensure compliance when issuing credits.
Idempotency
Use idempotency_id to prevent duplicate credits.
Additional Considerations
Risk Management
Direct credits carry higher risk. Implement appropriate controls and verification processes.
Customer Communication
Inform customers when credits are issued and provide details about the transaction.
Fees and Costs
Understand any fees associated with issuing credits and factor them into your business processes.