Create a Payment
Creates a transaction from a user or a payment customer to the app. User the `/users/{user_id}/payout-methods` route to get a user's stored payment methods.
Creates a transaction from a user or a payment customer to the app. User the /users/{user_id}/payout-methods route to get a user's stored payment methods.
Authorization
api_key In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v2/payments" \ -H "Content-Type: application/json" \ -d '{ "amount": 1, "platform": "ach" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "created": "2019-08-24T14:15:22Z", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "status": "created", "error": "account_closed", "error_message": "string", "sender_details": { "name": "string", "bank_name": "string", "routing_number": "string", "account_number_last4": "string", "trace_number": "string", "reference": "string", "memo": "string" }, "type": "refill", "amount": "string", "external_data": { "account_id": "string", "external_id": "string", "platform": "ach" }, "transactions": [ { "id": 0, "amount": "string", "created": "2019-08-24T14:15:22Z", "source_name": "string", "destination_name": "string", "type": "balance", "metadata": "string", "transfer_id": "d4a2d8dd-7def-4545-a062-761683b9aa05", "transfer": {} } ], "payout_link_id": "50673cb3-bf8b-4fdc-9f5f-114b168da4ab", "metadata": "string"}Retrieve a Payout Batch with detailed results
Get a payout batch by its id. Returns detailed results for each item in the batch, including transfer information for successful payouts and error messages for failed ones.
List all Payout Agents
List every payout agent in your application, newest first. A payout agent credential returns only its own agent. This list is not paginated.