---
updatedAt: 2025-06-13T00:00:18.000Z
agentTools:
  projectIndex: https://docs.fiatrepublic.com/llms.txt
---

# Create Payment Channel

The provided payload applies to two different payment channels: card and bank account. This means that the API user will have to choose one of these channels to process their payment transaction. It is important to understand that the payload for each channel is different and needs to be used correctly to ensure that the payment is processed successfully.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "transaction-monitoring",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://sandbox-oxygen.fiatrepublic.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/events/payment-channels": {
      "post": {
        "summary": "Create Payment Channel",
        "description": "The provided payload applies to two different payment channels: card and bank account. This means that the API user will have to choose one of these channels to process their payment transaction. It is important to understand that the payload for each channel is different and needs to be used correctly to ensure that the payment is processed successfully.",
        "operationId": "oxygen-create-payment-channel",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "type",
                  "externalId"
                ],
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "Type of the payment channel: BANK_ACCOUNT",
                    "enum": [
                      "BANK_ACCOUNT"
                    ]
                  },
                  "externalId": {
                    "type": "string",
                    "description": "Id of the bank account (payment channel) within the Member's system"
                  },
                  "externalCreatedAt": {
                    "type": "integer",
                    "description": "Date of payment channel creation within Member's system",
                    "format": "int32"
                  },
                  "externalUpdatedAt": {
                    "type": "integer",
                    "description": "Date of the payment channel's update",
                    "format": "int32"
                  },
                  "metadata": {
                    "type": "array",
                    "description": "Additional data",
                    "items": {
                      "type": "string"
                    }
                  },
                  "country": {
                    "type": "string",
                    "description": "Country code: Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom,"
                  },
                  "externalStatus": {
                    "type": "string",
                    "description": "For BANK ACCOUNT: Status of the payment channel within Member's system e.g. ACTIVE, BLOCKED"
                  },
                  "bankName": {
                    "type": "string",
                    "description": "For BANK_ACCOUNT: Name of the bank under which the account has been created"
                  },
                  "accountHolderName": {
                    "type": "string",
                    "description": "For BANK_ACCOUNT: Full name of the account holder"
                  },
                  "iban": {
                    "type": "string",
                    "description": "For BANK_ACCOUNT: IBAN associated with the account"
                  },
                  "bic": {
                    "type": "string",
                    "description": "For BANK_ACCOUNT: SWIFT BIC associated with the account"
                  },
                  "accountNumber": {
                    "type": "string",
                    "description": "For BANK_ACCOUNT: Account Number associated with the account. Depending on the currency and country, account will typically have at least an IBAN or an accountNumber."
                  },
                  "routingCodes": {
                    "type": "string",
                    "description": "For BANK_ACCOUNT: One or more routing codes associated with the account. Typically used in conjunction with the account number."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "201",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```