POST/api/v1/financial/payment-methods

Create payment method

Creates a payment method using FinancialService.createPaymentMethod().

RBAC · financial

Request body

Content type: application/json · schema FinancialCreatePaymentMethodBody

client_idstring <uuid>Required

typestringRequired

Enum: credit_cardbank_account

last4stringRequired

min length 4 · max length 4

exp_monthstring

exp_yearstring

is_defaultboolean

is_deletedboolean

Response body

Success response 201 · schema FinancialInvoiceApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

201

Payment method created.

400

Invalid request payload.

401

API key missing/invalid.

403

financial:create permission denied.

500

Unexpected payment method creation failure.

POST /api/v1/financial/payment-methods

cURL

curl -X POST "https://algapsa.com/api/v1/financial/payment-methods" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "01HN2K7VRB9PQ3Y0000000000",
  "type": "credit_card",
  "last4": "xxxx",
  "exp_month": "string",
  "exp_year": "string",
  "is_default": false,
  "is_deleted": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/financial/payment-methods", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "type": "credit_card",
    "last4": "xxxx",
    "exp_month": "string",
    "exp_year": "string",
    "is_default": false,
    "is_deleted": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/financial/payment-methods");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""client_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""type"": ""credit_card"",
  ""last4"": ""xxxx"",
  ""exp_month"": ""string"",
  ""exp_year"": ""string"",
  ""is_default"": false,
  ""is_deleted"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

201 OK·application/json

{
  "data": {},
  "meta": {}
}