Create a payment

curl --request POST \
  --url https://api.circle.com/v1/cpn/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quoteId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "idempotencyKey": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "beneficiaryAccountData": "eyJhbGciOiJFQ0RILUVTK0ExMjhLVyIsImVuYyI6IkExMjhHQ00iLCJlcGsiOnsiY3J2IjoiUC0yNTYiLCJrdHkiOiJFQyIsIngiOiI1TEtTbUtsNmVYV0dQNHlGb2tVaks4RGppU0l5YWpQdzJ6UUp1YVhFbEZzIiwieSI6IlRVT29MTV8wc294b0UzYVFmSExlUzRlRkZ3RU9tZ1VDRUh1eDVRMXdVYTQifX0.kVGnfB8eIqxq3bMvhedxUmZvkCrRfQOy.bTUOc_ilvZjb9VYP.pOS6Ul8Jnp_pijWtaQYC0b1NLN1Nc-t_MTsfj5EZy6s62ijQWGtAoo3enwx3gOpXIQDIIF7c-F3KSrVO33a5RIF8a4tvU7pRk_JDKVgHFVpSzvOaUHNHsMUvvctAncx1SneVE_gnm5ATkWO4_1i7irTkb-cjWLmvJ1vVEyJiC9ZgsEdK_eBAewpZTyyKxvoxBpo8IZ3g7qax712TvMsNpIJ_faQmsyRKwt2kBxDPyrWILcIvS1qij6uVOsEP2R6LXbWfBqVbklsgNPWjndXSmOJmsTdBjFzublMLSHmLxkfaD9gt3DxgD16rqDlKO9KmaRF3r322VumP4hrlfOsZUHHcVGeTpgjZwI9jrj76PiYtyCOeR7-kz97PamqrOQAfWRE8Rcp8QdCO6yFHFe3N2pI5kWakH783DVDAsm_x2VY_V8vCDe-xkIoJOabx3LqaxHq8_x_ATXZ01NX-5F9VqgtE73FOIGhinxt8G-Kfxvdlx6gv-QSfBvigVuoR1OCSPNB3OHirEKXY3IjWnjZuENNnXl9CqrCsHQZS1eb1KcaIkg_2NF6gi54htX6ijpUtyXS03IGZW6Bn6CSWqmmvMStIAIYO-8ZJrrleeCfU6WY5KjFlIvN6th-tE41JNJWS9mVqhjzwPC7GQ5bGkqq2zJKhALOuN_0oG4jXOYo1s3YAn-xw3kpq46fYyUrX4nLSocaKDeKOMMqh57_jcMDmHrXdmjlHGPMrBPdU_deub121c3ofTKgJg4KRC8mcTYcXe71uflARAr24msd9A_IPPVbhfvs06HOVKL2-jK6r_WL_9vWU3q-OPQHU3eWUOhI18vZ0CkGqJjtEKyBBmc4inWEbrsO02P2Zd5VTBCIoAaNrpY6n5mNyKPo6-PyrxNy27d6u2yoZvjG6QSuUO9DaX4AyGsE87agh_XgLW9RPXfcZQ7F5aUCQwEA0cF9YSEaYYBGziS7oQ99D1th1MQqEPcFxD5YPdyaPykU3Zbf5T8HSZz1risMbgQu97eXoarxm801pdw5cuKijqj39BVrgdLUfaQ9P-iGWcVJk8ZVXfHK3JHGaBuIjYNIy5lHF3TsKgV2x-wWxqER9vPdgejAGirkxHQaKPt2rg0rmbk3R7YTibT7yTKwO1PRiewi0lxKWvZqDbCoedyuYZCR0vup4S1ZVYX6uGBn-F5ODrnLoAZTbnV1tjDJgxFpA8EKsXWTrc78XH0715lY2OnbDtBOLMbxFJjK1_YDRU2UMkZTEx5BrhR4YibBd4-BCZT-dWTxanOHMxTKl823tyggY5lBQ8DlsLj1qZpOxKWYTM8WrLCZa7vZo9FmXw38FxYrqbwespe7xdS7onfmlI4Ug92eTtZ31FbZfcqOiAGgH9Etkj1M9scP0is6zVC6cIUQzC3NmHNxNtPv6XjMUWigijosvs7x9-qyVCqzJZlEGck2BJ6Uk7ug9QKcxHtaWgtuHPnA77KVE3Vi_dikYaXzxIdgjrGtqqUhXEhrAFkesvJ0UeH1ac94e-R8UrJX75w4DDoRyaFxQhDFdHVtD0ceVN7ekYJkmoS2eSAzWDwsKUvUrmafcfpQ922tZGq0RvnMh39SWy6I6xRFyYHarra24Gbawa5_THjB8TkHJ180giPC3KQAa_6Vz8CP-fks6_-MdGXPW0SYhNghNi_14ZXQ3rZYHaTICgeHhBfhJ4MQ6OlRkiRCrIkM5WSOTS_H715aeyUCL-dlZ0TiG2DpAIXkN1KMRp0jL_W12pg5SjKFAlOGnQgkgj9rO_C7pLxMyIhgEUKPHXMGN6Q7tpVhAAyTl0tabd7cvyWnf5L4UiyIpvb1qrt1bY6-VNA4KXz6Y5uiiBYFF_FIN3K6YZCT4l0zuh_gxmP9eba7zM5kgas1tr1IxYWI-mQiE9Rb8rX0hqXpMj27h9Mf_Sn56TJeEmW8d8x2Xy2Nb7KU9vQO-6uc_taXP0Lv5LFcSwZkdVe7FOeZD-GoaNDly9MdhXI4ELP4MOZXZFJeN7aCJvJeLRBPWnoM2aazDwtlA_KfhZVFtCsKKjJazv6J9h6CDHAm7NuexVJiPdtS1yknQDWrIBfneaLJasmtuhuAbRPtiTvvhQOXt51q0G7sjCSmmeNMwb5fFphe4wLJNmsbdgMFDcUVzb0ImIArCxqBEEK8uuRGcYaRifaLv0zkk29NAT99Ux580zaeN_x7aIMpJTt7jLP0-HZ-QU3MAGg3PLJ3_Oly6ABoULkEkmRhF0TtpU8z-kmmN6FtmzZK74kYEC75smgVTnnJK1kBdsZw9cxHeUx8aDJGrS3OK-uYN0dPJls2LC7X1rHD7ES179nPVBeJA2REm-jSlhVlV_I7JrVzlcXs0Fhx0hX-OgMKz_yQNHnM6RbgGnSLDcvND7vXqkEMgHeDRomhU1hMeu0DymctTKawtzIkV7MYwoibLDUeMvaXN8MicMs64D8I3Ld7BLtFf9o8rMeeNJ0Om7xdl9SGD2RYAep0cxw2rEIIr859e1vutBuvrrMz09dZKd05t1lu0jRztkQzUW9N-VZh9muTAoh_s3NrF2ZTFnRAfzxohwNLxxmX-Ov94FXBhuRHBQXb931I5m2URglrYcoAZ8RFoiAWW2AkHcyb5PRoQIt-LQhOM-bcn1VB44Okh10jqWpGbLno6AvE5FcoRVcspb0tor9EbksW2cipoypcaat5NhQgvo2rAPmkHGi8iB-z_xWORvUkaA2xknNW59myO6qTvjYQ_1P1ESbRO30nUeqgP3VoZrC1-bi9IbgSi-na31xEhdr-ZGuvtRSzyhWwqfviJgSMZ6_kkGW3gUI4ldurTwss6gDHWYmdV-lHtPMfYuD2KMQk1EyJ-3vZx0syLKDACL37HqAYvkW5GiOxrK9cNrSInQ8rZMDkXsaCZMEtvs03Qw2DyCBdoFeXPvFHJ6Vetou-7Oo6rdlmSkt5KdA-w9KKVIAt9WtYxNc-wjFm-vOMcOHb_xxzacDzYFJj8NxdW8GaVdrCvh3j5Yakr_3vSvRM5rpzQKMqw-B53SWV3oOHYu29qso5zSTz-dvAlZUL8Z1a3s13qdwhUkkRexIi6oTU0Da21pT-gCan2jSY_VKR8JdirKTLocn74JZ3InF8iH8XhOD0X7ySIbB69HqMLYRd9r13q2odfJ3cN1CWSF71zgIuZoYSbkO9DeFvCImA-WEIWrP1kJiYlpJi8VnFNQs8XWIxdCydft-8zvoXZbi0MoNt3kJExbKx7dReHx6B-6iwjuW8-o5RbeMvdTIYTp-y6YPsFhcVCvTlS7IefXqG4G3OrnNc5JIVnvdYXWCWUdWguiKdqB6FL_LSWOtsWrB6nIv69WP1WJJSa0Oa_EkxEwXK1BGH9-QpMqkP6rATSvsbaTywfCxqUqm7SzYH81lSCIvI5J7bWX5blk9rNZbp3aSeEpVRm03vwLrgUHLv9vMAopNnw5fZGKfcg3I5ZWYHNQo5BZk9LVpebMBYGijwNDnuFu08eF7ShlEzy50NsvgeDxZtfUVx8cviYn0MoTJBPlz1mXRSIr3zDIpefxDGnsQ1KK8LTi0Gbnt_ybeiT4yTmajrPLE4566D6AQIdDmCg_RsBtB_lAw.S2qu0MNMu2WNiEYoHh25ww",
  "travelRuleData": "eyJhbGciOiJFQ0RILUVTK0ExMjhLVyIsImVuYyI6IkExMjhHQ00iLCJlcGsiOnsiY3J2IjoiUC0yNTYiLCJrdHkiOiJFQyIsIngiOiI1TEtTbUtsNmVYV0dQNHlGb2tVaks4RGppU0l5YWpQdzJ6UUp1YVhFbEZzIiwieSI6IlRVT29MTV8wc294b0UzYVFmSExlUzRlRkZ3RU9tZ1VDRUh1eDVRMXdVYTQifX0.kVGnfB8eIqxq3bMvhedxUmZvkCrRfQOy.bTUOc_ilvZjb9VYP.pOS6Ul8Jnp_pijWtaQYC0b1NLN1Nc-t_MTsfj5EZy6s62ijQWGtAoo3enwx3gOpXIQDIIF7c-F3KSrVO33a5RIF8a4tvU7pRk_JDKVgHFVpSzvOaUHNHsMUvvctAncx1SneVE_gnm5ATkWO4_1i7irTkb-cjWLmvJ1vVEyJiC9ZgsEdK_eBAewpZTyyKxvoxBpo8IZ3g7qax712TvMsNpIJ_faQmsyRKwt2kBxDPyrWILcIvS1qij6uVOsEP2R6LXbWfBqVbklsgNPWjndXSmOJmsTdBjFzublMLSHmLxkfaD9gt3DxgD16rqDlKO9KmaRF3r322VumP4hrlfOsZUHHcVGeTpgjZwI9jrj76PiYtyCOeR7-kz97PamqrOQAfWRE8Rcp8QdCO6yFHFe3N2pI5kWakH783DVDAsm_x2VY_V8vCDe-xkIoJOabx3LqaxHq8_x_ATXZ01NX-5F9VqgtE73FOIGhinxt8G-Kfxvdlx6gv-QSfBvigVuoR1OCSPNB3OHirEKXY3IjWnjZuENNnXl9CqrCsHQZS1eb1KcaIkg_2NF6gi54htX6ijpUtyXS03IGZW6Bn6CSWqmmvMStIAIYO-8ZJrrleeCfU6WY5KjFlIvN6th-tE41JNJWS9mVqhjzwPC7GQ5bGkqq2zJKhALOuN_0oG4jXOYo1s3YAn-xw3kpq46fYyUrX4nLSocaKDeKOMMqh57_jcMDmHrXdmjlHGPMrBPdU_deub121c3ofTKgJg4KRC8mcTYcXe71uflARAr24msd9A_IPPVbhfvs06HOVKL2-jK6r_WL_9vWU3q-OPQHU3eWUOhI18vZ0CkGqJjtEKyBBmc4inWEbrsO02P2Zd5VTBCIoAaNrpY6n5mNyKPo6-PyrxNy27d6u2yoZvjG6QSuUO9DaX4AyGsE87agh_XgLW9RPXfcZQ7F5aUCQwEA0cF9YSEaYYBGziS7oQ99D1th1MQqEPcFxD5YPdyaPykU3Zbf5T8HSZz1risMbgQu97eXoarxm801pdw5cuKijqj39BVrgdLUfaQ9P-iGWcVJk8ZVXfHK3JHGaBuIjYNIy5lHF3TsKgV2x-wWxqER9vPdgejAGirkxHQaKPt2rg0rmbk3R7YTibT7yTKwO1PRiewi0lxKWvZqDbCoedyuYZCR0vup4S1ZVYX6uGBn-F5ODrnLoAZTbnV1tjDJgxFpA8EKsXWTrc78XH0715lY2OnbDtBOLMbxFJjK1_YDRU2UMkZTEx5BrhR4YibBd4-BCZT-dWTxanOHMxTKl823tyggY5lBQ8DlsLj1qZpOxKWYTM8WrLCZa7vZo9FmXw38FxYrqbwespe7xdS7onfmlI4Ug92eTtZ31FbZfcqOiAGgH9Etkj1M9scP0is6zVC6cIUQzC3NmHNxNtPv6XjMUWigijosvs7x9-qyVCqzJZlEGck2BJ6Uk7ug9QKcxHtaWgtuHPnA77KVE3Vi_dikYaXzxIdgjrGtqqUhXEhrAFkesvJ0UeH1ac94e-R8UrJX75w4DDoRyaFxQhDFdHVtD0ceVN7ekYJkmoS2eSAzWDwsKUvUrmafcfpQ922tZGq0RvnMh39SWy6I6xRFyYHarra24Gbawa5_THjB8TkHJ180giPC3KQAa_6Vz8CP-fks6_-MdGXPW0SYhNghNi_14ZXQ3rZYHaTICgeHhBfhJ4MQ6OlRkiRCrIkM5WSOTS_H715aeyUCL-dlZ0TiG2DpAIXkN1KMRp0jL_W12pg5SjKFAlOGnQgkgj9rO_C7pLxMyIhgEUKPHXMGN6Q7tpVhAAyTl0tabd7cvyWnf5L4UiyIpvb1qrt1bY6-VNA4KXz6Y5uiiBYFF_FIN3K6YZCT4l0zuh_gxmP9eba7zM5kgas1tr1IxYWI-mQiE9Rb8rX0hqXpMj27h9Mf_Sn56TJeEmW8d8x2Xy2Nb7KU9vQO-6uc_taXP0Lv5LFcSwZkdVe7FOeZD-GoaNDly9MdhXI4ELP4MOZXZFJeN7aCJvJeLRBPWnoM2aazDwtlA_KfhZVFtCsKKjJazv6J9h6CDHAm7NuexVJiPdtS1yknQDWrIBfneaLJasmtuhuAbRPtiTvvhQOXt51q0G7sjCSmmeNMwb5fFphe4wLJNmsbdgMFDcUVzb0ImIArCxqBEEK8uuRGcYaRifaLv0zkk29NAT99Ux580zaeN_x7aIMpJTt7jLP0-HZ-QU3MAGg3PLJ3_Oly6ABoULkEkmRhF0TtpU8z-kmmN6FtmzZK74kYEC75smgVTnnJK1kBdsZw9cxHeUx8aDJGrS3OK-uYN0dPJls2LC7X1rHD7ES179nPVBeJA2REm-jSlhVlV_I7JrVzlcXs0Fhx0hX-OgMKz_yQNHnM6RbgGnSLDcvND7vXqkEMgHeDRomhU1hMeu0DymctTKawtzIkV7MYwoibLDUeMvaXN8MicMs64D8I3Ld7BLtFf9o8rMeeNJ0Om7xdl9SGD2RYAep0cxw2rEIIr859e1vutBuvrrMz09dZKd05t1lu0jRztkQzUW9N-VZh9muTAoh_s3NrF2ZTFnRAfzxohwNLxxmX-Ov94FXBhuRHBQXb931I5m2URglrYcoAZ8RFoiAWW2AkHcyb5PRoQIt-LQhOM-bcn1VB44Okh10jqWpGbLno6AvE5FcoRVcspb0tor9EbksW2cipoypcaat5NhQgvo2rAPmkHGi8iB-z_xWORvUkaA2xknNW59myO6qTvjYQ_1P1ESbRO30nUeqgP3VoZrC1-bi9IbgSi-na31xEhdr-ZGuvtRSzyhWwqfviJgSMZ6_kkGW3gUI4ldurTwss6gDHWYmdV-lHtPMfYuD2KMQk1EyJ-3vZx0syLKDACL37HqAYvkW5GiOxrK9cNrSInQ8rZMDkXsaCZMEtvs03Qw2DyCBdoFeXPvFHJ6Vetou-7Oo6rdlmSkt5KdA-w9KKVIAt9WtYxNc-wjFm-vOMcOHb_xxzacDzYFJj8NxdW8GaVdrCvh3j5Yakr_3vSvRM5rpzQKMqw-B53SWV3oOHYu29qso5zSTz-dvAlZUL8Z1a3s13qdwhUkkRexIi6oTU0Da21pT-gCan2jSY_VKR8JdirKTLocn74JZ3InF8iH8XhOD0X7ySIbB69HqMLYRd9r13q2odfJ3cN1CWSF71zgIuZoYSbkO9DeFvCImA-WEIWrP1kJiYlpJi8VnFNQs8XWIxdCydft-8zvoXZbi0MoNt3kJExbKx7dReHx6B-6iwjuW8-o5RbeMvdTIYTp-y6YPsFhcVCvTlS7IefXqG4G3OrnNc5JIVnvdYXWCWUdWguiKdqB6FL_LSWOtsWrB6nIv69WP1WJJSa0Oa_EkxEwXK1BGH9-QpMqkP6rATSvsbaTywfCxqUqm7SzYH81lSCIvI5J7bWX5blk9rNZbp3aSeEpVRm03vwLrgUHLv9vMAopNnw5fZGKfcg3I5ZWYHNQo5BZk9LVpebMBYGijwNDnuFu08eF7ShlEzy50NsvgeDxZtfUVx8cviYn0MoTJBPlz1mXRSIr3zDIpefxDGnsQ1KK8LTi0Gbnt_ybeiT4yTmajrPLE4566D6AQIdDmCg_RsBtB_lAw.S2qu0MNMu2WNiEYoHh25ww",
  "customerRefId": "custom_ref_id",
  "useCase": "B2B",
  "reasonForPayment": "PMT001",
  "senderAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
  "blockchain": "ETH-SEPOLIA",
  "refundAddress": "0x7d9f3f9c2b7e4c0a5a9f3e8b4d2c1a0f5e6d7c8b",
  "beneficiaryRefId": "custom_ref_id",
  "refCode": "custom_ref_id"
}
'

{
  "data": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "quoteId": "custom_ref_id",
    "paymentMethodType": "SPEI",
    "blockchain": "ETH-SEPOLIA",
    "senderAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
    "refCode": "custom_ref_id",
    "customerRefId": "custom_ref_id",
    "expireDate": "2023-01-01T12:04:05Z",
    "createDate": "2023-01-01T12:04:05Z",
    "status": "COMPLETED",
    "useCase": "B2B",
    "reasonForPayment": "PMT001",
    "sourceAmount": {
      "amount": "110.270000",
      "currency": "USDC"
    },
    "destinationAmount": {
      "amount": "183.24",
      "currency": "MXN"
    },
    "fees": {
      "breakdown": [
        {
          "amount": {
            "amount": "0.240000",
            "currency": "USDC"
          },
          "type": "BFI_TRANSACTION_FEE"
        }
      ],
      "totalAmount": {
        "amount": "110.270000",
        "currency": "USDC"
      }
    },
    "beneficiaryRefId": "custom_ref_id",
    "fiatNetworkPaymentRef": "custom_ref_id",
    "failureReason": "CANCELLED",
    "failureCode": "PM01001",
    "activeRfi": {
      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "status": "APPROVED",
      "level": "LEVEL_1",
      "expireDate": "2023-01-01T12:04:05Z",
      "certificate": {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "certPem": "LS0tLS1CRUdJT...",
        "domain": "api.circle.com",
        "jwk": {
          "crv": "P-256",
          "kid": "263521881931753643998528753619816524468853605762",
          "kty": "EC",
          "x": "KnxBe8fb2mL_Ve9-tqjGSkGgE9f0yohMkAvH_InaFtE",
          "y": "D41cVUpiKcey4LJKNFtUtmVHDWRmhjZapPLfryX5b1o"
        }
      },
      "fieldRequirements": {
        "version": 1,
        "schema": {
          "type": "object",
          "$defs": {
            "address": {
              "type": "object",
              "required": [
                "street",
                "city",
                "country"
              ],
              "properties": {
                "city": {
                  "type": "string",
                  "description": "City name"
                },
                "street": {
                  "type": "string",
                  "description": "Street address"
                },
                "country": {
                  "type": "string",
                  "pattern": "^[A-Z]{2}$",
                  "description": "Country code (e.g., US, GB)"
                },
                "postalCode": {
                  "type": "string",
                  "description": "Postal or ZIP code"
                },
                "stateProvince": {
                  "type": "string",
                  "description": "State or province"
                }
              },
              "description": "Full address"
            },
            "individual": {
              "type": "object",
              "required": [
                "name",
                "address",
                "dateOfBirth"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Individual's full name"
                },
                "address": {
                  "ref": "#/$defs/address"
                },
                "dateOfBirth": {
                  "type": "string",
                  "format": "date",
                  "description": "Individual's date of birth (YYYY-MM-DD)"
                }
              },
              "description": "Individual's RFI data"
            },
            "beneficiaryOwner": {
              "type": "object",
              "required": [
                "name",
                "address",
                "dateOfBirth",
                "percentage"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Individual's full name"
                },
                "address": {
                  "ref": "#/$defs/address"
                },
                "percentage": {
                  "type": "number",
                  "description": "Company ownership percentage"
                },
                "dateOfBirth": {
                  "type": "string",
                  "format": "date",
                  "description": "Individual's date of birth (YYYY-MM-DD)"
                }
              },
              "description": "Beneficiary owner's RFI data"
            },
            "intermediaryBeneficiaryOwner": {
              "type": "object",
              "required": [
                "name",
                "address",
                "dateOfFormation",
                "countryOfFormation",
                "percentage"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Business legal name"
                },
                "address": {
                  "ref": "#/$defs/address"
                },
                "percentage": {
                  "type": "number",
                  "description": "Company ownership percentage"
                },
                "dateOfFormation": {
                  "type": "string",
                  "format": "date",
                  "description": "Company formation date (YYYY-MM-DD)"
                },
                "countryOfFormation": {
                  "type": "string",
                  "pattern": "^[A-Z]{2}$",
                  "description": "Entity formation country"
                }
              },
              "description": "Intermediary beneficiary owner's RFI data"
            }
          },
          "title": "RFI Requirements",
          "$schema": "https://json-schema.org/draft/2020-12/schema",
          "required": [
            "SOURCE_OF_FUNDS",
            "METHOD_OF_VERIFICATION",
            "NAME",
            "TRADE_NAME",
            "NATIONAL_IDENTIFICATION_NUMBER",
            "DATE_OF_FORMATION",
            "COUNTRY_OF_FORMATION",
            "ENTITY_TYPE",
            "INDUSTRY_TYPE",
            "ADDRESS",
            "AUTHORIZED_SIGNATORIES",
            "BENEFICIARY_OWNERSHIP"
          ],
          "properties": {
            "NAME": {
              "type": "string",
              "description": "Business legal registered name"
            },
            "EMAIL": {
              "type": "string",
              "description": "Business contact email address"
            },
            "PHONE": {
              "type": "string",
              "description": "Business contact phone number"
            },
            "ADDRESS": {
              "ref": "#/$defs/address"
            },
            "WEBSITE": {
              "type": "string",
              "description": "Business website URL"
            },
            "TRADE_NAME": {
              "type": "string",
              "description": "Business trade name or DBA (Doing Business As)"
            },
            "ENTITY_TYPE": {
              "type": "string",
              "description": "Business structure type (Corporation, LLC, Partnership, etc.)"
            },
            "INDUSTRY_TYPE": {
              "type": "string",
              "description": "Business activity classification"
            },
            "SOURCE_OF_FUNDS": {
              "type": "string",
              "description": "Transaction source of funds"
            },
            "DATE_OF_FORMATION": {
              "type": "string",
              "format": "date",
              "description": "Company formation date (YYYY-MM-DD)"
            },
            "BENEFICIARY_OWNERS": {
              "ref": "#/$defs/beneficiaryOwner"
            },
            "COUNTRY_OF_FORMATION": {
              "type": "string",
              "pattern": "^[A-Z]{2}$",
              "description": "Entity formation country"
            },
            "BENEFICIARY_OWNERSHIP": {
              "type": "boolean",
              "description": "Whether any individuals or intermediaries own 25% or more of the company"
            },
            "AUTHORIZED_SIGNATORIES": {
              "ref": "#/$defs/individual"
            },
            "METHOD_OF_VERIFICATION": {
              "type": "string",
              "description": "Verification method used"
            },
            "NATIONAL_IDENTIFICATION_NUMBER": {
              "type": "string",
              "description": "Business identification number (e.g., Tax ID)"
            },
            "INTERMEDIARY_BENEFICIARY_OWNERS": {
              "ref": "#/$defs/intermediaryBeneficiaryOwner"
            }
          },
          "description": "RFI Data Requirements"
        }
      },
      "fileRequirements": [
        "FORMATION_DOCUMENT"
      ]
    },
    "rfis": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "status": "APPROVED"
      }
    ],
    "onChainTransactions": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "status": "PENDING"
      }
    ],
    "fiatSettlementTime": {
      "max": "3",
      "min": "1",
      "unit": "DAYS"
    },
    "refunds": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "status": "CREATED",
        "amount": {
          "amount": "110.270000",
          "currency": "USDC"
        },
        "transactionHash": "<string>"
      }
    ],
    "metadata": {},
    "statusAddendum": "IN_MANUAL_REVIEW"
  }
}

POST

cpn

payments

Create a payment

curl --request POST \
  --url https://api.circle.com/v1/cpn/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quoteId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "idempotencyKey": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "beneficiaryAccountData": "eyJhbGciOiJFQ0RILUVTK0ExMjhLVyIsImVuYyI6IkExMjhHQ00iLCJlcGsiOnsiY3J2IjoiUC0yNTYiLCJrdHkiOiJFQyIsIngiOiI1TEtTbUtsNmVYV0dQNHlGb2tVaks4RGppU0l5YWpQdzJ6UUp1YVhFbEZzIiwieSI6IlRVT29MTV8wc294b0UzYVFmSExlUzRlRkZ3RU9tZ1VDRUh1eDVRMXdVYTQifX0.kVGnfB8eIqxq3bMvhedxUmZvkCrRfQOy.bTUOc_ilvZjb9VYP.pOS6Ul8Jnp_pijWtaQYC0b1NLN1Nc-t_MTsfj5EZy6s62ijQWGtAoo3enwx3gOpXIQDIIF7c-F3KSrVO33a5RIF8a4tvU7pRk_JDKVgHFVpSzvOaUHNHsMUvvctAncx1SneVE_gnm5ATkWO4_1i7irTkb-cjWLmvJ1vVEyJiC9ZgsEdK_eBAewpZTyyKxvoxBpo8IZ3g7qax712TvMsNpIJ_faQmsyRKwt2kBxDPyrWILcIvS1qij6uVOsEP2R6LXbWfBqVbklsgNPWjndXSmOJmsTdBjFzublMLSHmLxkfaD9gt3DxgD16rqDlKO9KmaRF3r322VumP4hrlfOsZUHHcVGeTpgjZwI9jrj76PiYtyCOeR7-kz97PamqrOQAfWRE8Rcp8QdCO6yFHFe3N2pI5kWakH783DVDAsm_x2VY_V8vCDe-xkIoJOabx3LqaxHq8_x_ATXZ01NX-5F9VqgtE73FOIGhinxt8G-Kfxvdlx6gv-QSfBvigVuoR1OCSPNB3OHirEKXY3IjWnjZuENNnXl9CqrCsHQZS1eb1KcaIkg_2NF6gi54htX6ijpUtyXS03IGZW6Bn6CSWqmmvMStIAIYO-8ZJrrleeCfU6WY5KjFlIvN6th-tE41JNJWS9mVqhjzwPC7GQ5bGkqq2zJKhALOuN_0oG4jXOYo1s3YAn-xw3kpq46fYyUrX4nLSocaKDeKOMMqh57_jcMDmHrXdmjlHGPMrBPdU_deub121c3ofTKgJg4KRC8mcTYcXe71uflARAr24msd9A_IPPVbhfvs06HOVKL2-jK6r_WL_9vWU3q-OPQHU3eWUOhI18vZ0CkGqJjtEKyBBmc4inWEbrsO02P2Zd5VTBCIoAaNrpY6n5mNyKPo6-PyrxNy27d6u2yoZvjG6QSuUO9DaX4AyGsE87agh_XgLW9RPXfcZQ7F5aUCQwEA0cF9YSEaYYBGziS7oQ99D1th1MQqEPcFxD5YPdyaPykU3Zbf5T8HSZz1risMbgQu97eXoarxm801pdw5cuKijqj39BVrgdLUfaQ9P-iGWcVJk8ZVXfHK3JHGaBuIjYNIy5lHF3TsKgV2x-wWxqER9vPdgejAGirkxHQaKPt2rg0rmbk3R7YTibT7yTKwO1PRiewi0lxKWvZqDbCoedyuYZCR0vup4S1ZVYX6uGBn-F5ODrnLoAZTbnV1tjDJgxFpA8EKsXWTrc78XH0715lY2OnbDtBOLMbxFJjK1_YDRU2UMkZTEx5BrhR4YibBd4-BCZT-dWTxanOHMxTKl823tyggY5lBQ8DlsLj1qZpOxKWYTM8WrLCZa7vZo9FmXw38FxYrqbwespe7xdS7onfmlI4Ug92eTtZ31FbZfcqOiAGgH9Etkj1M9scP0is6zVC6cIUQzC3NmHNxNtPv6XjMUWigijosvs7x9-qyVCqzJZlEGck2BJ6Uk7ug9QKcxHtaWgtuHPnA77KVE3Vi_dikYaXzxIdgjrGtqqUhXEhrAFkesvJ0UeH1ac94e-R8UrJX75w4DDoRyaFxQhDFdHVtD0ceVN7ekYJkmoS2eSAzWDwsKUvUrmafcfpQ922tZGq0RvnMh39SWy6I6xRFyYHarra24Gbawa5_THjB8TkHJ180giPC3KQAa_6Vz8CP-fks6_-MdGXPW0SYhNghNi_14ZXQ3rZYHaTICgeHhBfhJ4MQ6OlRkiRCrIkM5WSOTS_H715aeyUCL-dlZ0TiG2DpAIXkN1KMRp0jL_W12pg5SjKFAlOGnQgkgj9rO_C7pLxMyIhgEUKPHXMGN6Q7tpVhAAyTl0tabd7cvyWnf5L4UiyIpvb1qrt1bY6-VNA4KXz6Y5uiiBYFF_FIN3K6YZCT4l0zuh_gxmP9eba7zM5kgas1tr1IxYWI-mQiE9Rb8rX0hqXpMj27h9Mf_Sn56TJeEmW8d8x2Xy2Nb7KU9vQO-6uc_taXP0Lv5LFcSwZkdVe7FOeZD-GoaNDly9MdhXI4ELP4MOZXZFJeN7aCJvJeLRBPWnoM2aazDwtlA_KfhZVFtCsKKjJazv6J9h6CDHAm7NuexVJiPdtS1yknQDWrIBfneaLJasmtuhuAbRPtiTvvhQOXt51q0G7sjCSmmeNMwb5fFphe4wLJNmsbdgMFDcUVzb0ImIArCxqBEEK8uuRGcYaRifaLv0zkk29NAT99Ux580zaeN_x7aIMpJTt7jLP0-HZ-QU3MAGg3PLJ3_Oly6ABoULkEkmRhF0TtpU8z-kmmN6FtmzZK74kYEC75smgVTnnJK1kBdsZw9cxHeUx8aDJGrS3OK-uYN0dPJls2LC7X1rHD7ES179nPVBeJA2REm-jSlhVlV_I7JrVzlcXs0Fhx0hX-OgMKz_yQNHnM6RbgGnSLDcvND7vXqkEMgHeDRomhU1hMeu0DymctTKawtzIkV7MYwoibLDUeMvaXN8MicMs64D8I3Ld7BLtFf9o8rMeeNJ0Om7xdl9SGD2RYAep0cxw2rEIIr859e1vutBuvrrMz09dZKd05t1lu0jRztkQzUW9N-VZh9muTAoh_s3NrF2ZTFnRAfzxohwNLxxmX-Ov94FXBhuRHBQXb931I5m2URglrYcoAZ8RFoiAWW2AkHcyb5PRoQIt-LQhOM-bcn1VB44Okh10jqWpGbLno6AvE5FcoRVcspb0tor9EbksW2cipoypcaat5NhQgvo2rAPmkHGi8iB-z_xWORvUkaA2xknNW59myO6qTvjYQ_1P1ESbRO30nUeqgP3VoZrC1-bi9IbgSi-na31xEhdr-ZGuvtRSzyhWwqfviJgSMZ6_kkGW3gUI4ldurTwss6gDHWYmdV-lHtPMfYuD2KMQk1EyJ-3vZx0syLKDACL37HqAYvkW5GiOxrK9cNrSInQ8rZMDkXsaCZMEtvs03Qw2DyCBdoFeXPvFHJ6Vetou-7Oo6rdlmSkt5KdA-w9KKVIAt9WtYxNc-wjFm-vOMcOHb_xxzacDzYFJj8NxdW8GaVdrCvh3j5Yakr_3vSvRM5rpzQKMqw-B53SWV3oOHYu29qso5zSTz-dvAlZUL8Z1a3s13qdwhUkkRexIi6oTU0Da21pT-gCan2jSY_VKR8JdirKTLocn74JZ3InF8iH8XhOD0X7ySIbB69HqMLYRd9r13q2odfJ3cN1CWSF71zgIuZoYSbkO9DeFvCImA-WEIWrP1kJiYlpJi8VnFNQs8XWIxdCydft-8zvoXZbi0MoNt3kJExbKx7dReHx6B-6iwjuW8-o5RbeMvdTIYTp-y6YPsFhcVCvTlS7IefXqG4G3OrnNc5JIVnvdYXWCWUdWguiKdqB6FL_LSWOtsWrB6nIv69WP1WJJSa0Oa_EkxEwXK1BGH9-QpMqkP6rATSvsbaTywfCxqUqm7SzYH81lSCIvI5J7bWX5blk9rNZbp3aSeEpVRm03vwLrgUHLv9vMAopNnw5fZGKfcg3I5ZWYHNQo5BZk9LVpebMBYGijwNDnuFu08eF7ShlEzy50NsvgeDxZtfUVx8cviYn0MoTJBPlz1mXRSIr3zDIpefxDGnsQ1KK8LTi0Gbnt_ybeiT4yTmajrPLE4566D6AQIdDmCg_RsBtB_lAw.S2qu0MNMu2WNiEYoHh25ww",
  "travelRuleData": "eyJhbGciOiJFQ0RILUVTK0ExMjhLVyIsImVuYyI6IkExMjhHQ00iLCJlcGsiOnsiY3J2IjoiUC0yNTYiLCJrdHkiOiJFQyIsIngiOiI1TEtTbUtsNmVYV0dQNHlGb2tVaks4RGppU0l5YWpQdzJ6UUp1YVhFbEZzIiwieSI6IlRVT29MTV8wc294b0UzYVFmSExlUzRlRkZ3RU9tZ1VDRUh1eDVRMXdVYTQifX0.kVGnfB8eIqxq3bMvhedxUmZvkCrRfQOy.bTUOc_ilvZjb9VYP.pOS6Ul8Jnp_pijWtaQYC0b1NLN1Nc-t_MTsfj5EZy6s62ijQWGtAoo3enwx3gOpXIQDIIF7c-F3KSrVO33a5RIF8a4tvU7pRk_JDKVgHFVpSzvOaUHNHsMUvvctAncx1SneVE_gnm5ATkWO4_1i7irTkb-cjWLmvJ1vVEyJiC9ZgsEdK_eBAewpZTyyKxvoxBpo8IZ3g7qax712TvMsNpIJ_faQmsyRKwt2kBxDPyrWILcIvS1qij6uVOsEP2R6LXbWfBqVbklsgNPWjndXSmOJmsTdBjFzublMLSHmLxkfaD9gt3DxgD16rqDlKO9KmaRF3r322VumP4hrlfOsZUHHcVGeTpgjZwI9jrj76PiYtyCOeR7-kz97PamqrOQAfWRE8Rcp8QdCO6yFHFe3N2pI5kWakH783DVDAsm_x2VY_V8vCDe-xkIoJOabx3LqaxHq8_x_ATXZ01NX-5F9VqgtE73FOIGhinxt8G-Kfxvdlx6gv-QSfBvigVuoR1OCSPNB3OHirEKXY3IjWnjZuENNnXl9CqrCsHQZS1eb1KcaIkg_2NF6gi54htX6ijpUtyXS03IGZW6Bn6CSWqmmvMStIAIYO-8ZJrrleeCfU6WY5KjFlIvN6th-tE41JNJWS9mVqhjzwPC7GQ5bGkqq2zJKhALOuN_0oG4jXOYo1s3YAn-xw3kpq46fYyUrX4nLSocaKDeKOMMqh57_jcMDmHrXdmjlHGPMrBPdU_deub121c3ofTKgJg4KRC8mcTYcXe71uflARAr24msd9A_IPPVbhfvs06HOVKL2-jK6r_WL_9vWU3q-OPQHU3eWUOhI18vZ0CkGqJjtEKyBBmc4inWEbrsO02P2Zd5VTBCIoAaNrpY6n5mNyKPo6-PyrxNy27d6u2yoZvjG6QSuUO9DaX4AyGsE87agh_XgLW9RPXfcZQ7F5aUCQwEA0cF9YSEaYYBGziS7oQ99D1th1MQqEPcFxD5YPdyaPykU3Zbf5T8HSZz1risMbgQu97eXoarxm801pdw5cuKijqj39BVrgdLUfaQ9P-iGWcVJk8ZVXfHK3JHGaBuIjYNIy5lHF3TsKgV2x-wWxqER9vPdgejAGirkxHQaKPt2rg0rmbk3R7YTibT7yTKwO1PRiewi0lxKWvZqDbCoedyuYZCR0vup4S1ZVYX6uGBn-F5ODrnLoAZTbnV1tjDJgxFpA8EKsXWTrc78XH0715lY2OnbDtBOLMbxFJjK1_YDRU2UMkZTEx5BrhR4YibBd4-BCZT-dWTxanOHMxTKl823tyggY5lBQ8DlsLj1qZpOxKWYTM8WrLCZa7vZo9FmXw38FxYrqbwespe7xdS7onfmlI4Ug92eTtZ31FbZfcqOiAGgH9Etkj1M9scP0is6zVC6cIUQzC3NmHNxNtPv6XjMUWigijosvs7x9-qyVCqzJZlEGck2BJ6Uk7ug9QKcxHtaWgtuHPnA77KVE3Vi_dikYaXzxIdgjrGtqqUhXEhrAFkesvJ0UeH1ac94e-R8UrJX75w4DDoRyaFxQhDFdHVtD0ceVN7ekYJkmoS2eSAzWDwsKUvUrmafcfpQ922tZGq0RvnMh39SWy6I6xRFyYHarra24Gbawa5_THjB8TkHJ180giPC3KQAa_6Vz8CP-fks6_-MdGXPW0SYhNghNi_14ZXQ3rZYHaTICgeHhBfhJ4MQ6OlRkiRCrIkM5WSOTS_H715aeyUCL-dlZ0TiG2DpAIXkN1KMRp0jL_W12pg5SjKFAlOGnQgkgj9rO_C7pLxMyIhgEUKPHXMGN6Q7tpVhAAyTl0tabd7cvyWnf5L4UiyIpvb1qrt1bY6-VNA4KXz6Y5uiiBYFF_FIN3K6YZCT4l0zuh_gxmP9eba7zM5kgas1tr1IxYWI-mQiE9Rb8rX0hqXpMj27h9Mf_Sn56TJeEmW8d8x2Xy2Nb7KU9vQO-6uc_taXP0Lv5LFcSwZkdVe7FOeZD-GoaNDly9MdhXI4ELP4MOZXZFJeN7aCJvJeLRBPWnoM2aazDwtlA_KfhZVFtCsKKjJazv6J9h6CDHAm7NuexVJiPdtS1yknQDWrIBfneaLJasmtuhuAbRPtiTvvhQOXt51q0G7sjCSmmeNMwb5fFphe4wLJNmsbdgMFDcUVzb0ImIArCxqBEEK8uuRGcYaRifaLv0zkk29NAT99Ux580zaeN_x7aIMpJTt7jLP0-HZ-QU3MAGg3PLJ3_Oly6ABoULkEkmRhF0TtpU8z-kmmN6FtmzZK74kYEC75smgVTnnJK1kBdsZw9cxHeUx8aDJGrS3OK-uYN0dPJls2LC7X1rHD7ES179nPVBeJA2REm-jSlhVlV_I7JrVzlcXs0Fhx0hX-OgMKz_yQNHnM6RbgGnSLDcvND7vXqkEMgHeDRomhU1hMeu0DymctTKawtzIkV7MYwoibLDUeMvaXN8MicMs64D8I3Ld7BLtFf9o8rMeeNJ0Om7xdl9SGD2RYAep0cxw2rEIIr859e1vutBuvrrMz09dZKd05t1lu0jRztkQzUW9N-VZh9muTAoh_s3NrF2ZTFnRAfzxohwNLxxmX-Ov94FXBhuRHBQXb931I5m2URglrYcoAZ8RFoiAWW2AkHcyb5PRoQIt-LQhOM-bcn1VB44Okh10jqWpGbLno6AvE5FcoRVcspb0tor9EbksW2cipoypcaat5NhQgvo2rAPmkHGi8iB-z_xWORvUkaA2xknNW59myO6qTvjYQ_1P1ESbRO30nUeqgP3VoZrC1-bi9IbgSi-na31xEhdr-ZGuvtRSzyhWwqfviJgSMZ6_kkGW3gUI4ldurTwss6gDHWYmdV-lHtPMfYuD2KMQk1EyJ-3vZx0syLKDACL37HqAYvkW5GiOxrK9cNrSInQ8rZMDkXsaCZMEtvs03Qw2DyCBdoFeXPvFHJ6Vetou-7Oo6rdlmSkt5KdA-w9KKVIAt9WtYxNc-wjFm-vOMcOHb_xxzacDzYFJj8NxdW8GaVdrCvh3j5Yakr_3vSvRM5rpzQKMqw-B53SWV3oOHYu29qso5zSTz-dvAlZUL8Z1a3s13qdwhUkkRexIi6oTU0Da21pT-gCan2jSY_VKR8JdirKTLocn74JZ3InF8iH8XhOD0X7ySIbB69HqMLYRd9r13q2odfJ3cN1CWSF71zgIuZoYSbkO9DeFvCImA-WEIWrP1kJiYlpJi8VnFNQs8XWIxdCydft-8zvoXZbi0MoNt3kJExbKx7dReHx6B-6iwjuW8-o5RbeMvdTIYTp-y6YPsFhcVCvTlS7IefXqG4G3OrnNc5JIVnvdYXWCWUdWguiKdqB6FL_LSWOtsWrB6nIv69WP1WJJSa0Oa_EkxEwXK1BGH9-QpMqkP6rATSvsbaTywfCxqUqm7SzYH81lSCIvI5J7bWX5blk9rNZbp3aSeEpVRm03vwLrgUHLv9vMAopNnw5fZGKfcg3I5ZWYHNQo5BZk9LVpebMBYGijwNDnuFu08eF7ShlEzy50NsvgeDxZtfUVx8cviYn0MoTJBPlz1mXRSIr3zDIpefxDGnsQ1KK8LTi0Gbnt_ybeiT4yTmajrPLE4566D6AQIdDmCg_RsBtB_lAw.S2qu0MNMu2WNiEYoHh25ww",
  "customerRefId": "custom_ref_id",
  "useCase": "B2B",
  "reasonForPayment": "PMT001",
  "senderAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
  "blockchain": "ETH-SEPOLIA",
  "refundAddress": "0x7d9f3f9c2b7e4c0a5a9f3e8b4d2c1a0f5e6d7c8b",
  "beneficiaryRefId": "custom_ref_id",
  "refCode": "custom_ref_id"
}
'

{
  "data": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "quoteId": "custom_ref_id",
    "paymentMethodType": "SPEI",
    "blockchain": "ETH-SEPOLIA",
    "senderAddress": "0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c",
    "refCode": "custom_ref_id",
    "customerRefId": "custom_ref_id",
    "expireDate": "2023-01-01T12:04:05Z",
    "createDate": "2023-01-01T12:04:05Z",
    "status": "COMPLETED",
    "useCase": "B2B",
    "reasonForPayment": "PMT001",
    "sourceAmount": {
      "amount": "110.270000",
      "currency": "USDC"
    },
    "destinationAmount": {
      "amount": "183.24",
      "currency": "MXN"
    },
    "fees": {
      "breakdown": [
        {
          "amount": {
            "amount": "0.240000",
            "currency": "USDC"
          },
          "type": "BFI_TRANSACTION_FEE"
        }
      ],
      "totalAmount": {
        "amount": "110.270000",
        "currency": "USDC"
      }
    },
    "beneficiaryRefId": "custom_ref_id",
    "fiatNetworkPaymentRef": "custom_ref_id",
    "failureReason": "CANCELLED",
    "failureCode": "PM01001",
    "activeRfi": {
      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "status": "APPROVED",
      "level": "LEVEL_1",
      "expireDate": "2023-01-01T12:04:05Z",
      "certificate": {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "certPem": "LS0tLS1CRUdJT...",
        "domain": "api.circle.com",
        "jwk": {
          "crv": "P-256",
          "kid": "263521881931753643998528753619816524468853605762",
          "kty": "EC",
          "x": "KnxBe8fb2mL_Ve9-tqjGSkGgE9f0yohMkAvH_InaFtE",
          "y": "D41cVUpiKcey4LJKNFtUtmVHDWRmhjZapPLfryX5b1o"
        }
      },
      "fieldRequirements": {
        "version": 1,
        "schema": {
          "type": "object",
          "$defs": {
            "address": {
              "type": "object",
              "required": [
                "street",
                "city",
                "country"
              ],
              "properties": {
                "city": {
                  "type": "string",
                  "description": "City name"
                },
                "street": {
                  "type": "string",
                  "description": "Street address"
                },
                "country": {
                  "type": "string",
                  "pattern": "^[A-Z]{2}$",
                  "description": "Country code (e.g., US, GB)"
                },
                "postalCode": {
                  "type": "string",
                  "description": "Postal or ZIP code"
                },
                "stateProvince": {
                  "type": "string",
                  "description": "State or province"
                }
              },
              "description": "Full address"
            },
            "individual": {
              "type": "object",
              "required": [
                "name",
                "address",
                "dateOfBirth"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Individual's full name"
                },
                "address": {
                  "ref": "#/$defs/address"
                },
                "dateOfBirth": {
                  "type": "string",
                  "format": "date",
                  "description": "Individual's date of birth (YYYY-MM-DD)"
                }
              },
              "description": "Individual's RFI data"
            },
            "beneficiaryOwner": {
              "type": "object",
              "required": [
                "name",
                "address",
                "dateOfBirth",
                "percentage"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Individual's full name"
                },
                "address": {
                  "ref": "#/$defs/address"
                },
                "percentage": {
                  "type": "number",
                  "description": "Company ownership percentage"
                },
                "dateOfBirth": {
                  "type": "string",
                  "format": "date",
                  "description": "Individual's date of birth (YYYY-MM-DD)"
                }
              },
              "description": "Beneficiary owner's RFI data"
            },
            "intermediaryBeneficiaryOwner": {
              "type": "object",
              "required": [
                "name",
                "address",
                "dateOfFormation",
                "countryOfFormation",
                "percentage"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Business legal name"
                },
                "address": {
                  "ref": "#/$defs/address"
                },
                "percentage": {
                  "type": "number",
                  "description": "Company ownership percentage"
                },
                "dateOfFormation": {
                  "type": "string",
                  "format": "date",
                  "description": "Company formation date (YYYY-MM-DD)"
                },
                "countryOfFormation": {
                  "type": "string",
                  "pattern": "^[A-Z]{2}$",
                  "description": "Entity formation country"
                }
              },
              "description": "Intermediary beneficiary owner's RFI data"
            }
          },
          "title": "RFI Requirements",
          "$schema": "https://json-schema.org/draft/2020-12/schema",
          "required": [
            "SOURCE_OF_FUNDS",
            "METHOD_OF_VERIFICATION",
            "NAME",
            "TRADE_NAME",
            "NATIONAL_IDENTIFICATION_NUMBER",
            "DATE_OF_FORMATION",
            "COUNTRY_OF_FORMATION",
            "ENTITY_TYPE",
            "INDUSTRY_TYPE",
            "ADDRESS",
            "AUTHORIZED_SIGNATORIES",
            "BENEFICIARY_OWNERSHIP"
          ],
          "properties": {
            "NAME": {
              "type": "string",
              "description": "Business legal registered name"
            },
            "EMAIL": {
              "type": "string",
              "description": "Business contact email address"
            },
            "PHONE": {
              "type": "string",
              "description": "Business contact phone number"
            },
            "ADDRESS": {
              "ref": "#/$defs/address"
            },
            "WEBSITE": {
              "type": "string",
              "description": "Business website URL"
            },
            "TRADE_NAME": {
              "type": "string",
              "description": "Business trade name or DBA (Doing Business As)"
            },
            "ENTITY_TYPE": {
              "type": "string",
              "description": "Business structure type (Corporation, LLC, Partnership, etc.)"
            },
            "INDUSTRY_TYPE": {
              "type": "string",
              "description": "Business activity classification"
            },
            "SOURCE_OF_FUNDS": {
              "type": "string",
              "description": "Transaction source of funds"
            },
            "DATE_OF_FORMATION": {
              "type": "string",
              "format": "date",
              "description": "Company formation date (YYYY-MM-DD)"
            },
            "BENEFICIARY_OWNERS": {
              "ref": "#/$defs/beneficiaryOwner"
            },
            "COUNTRY_OF_FORMATION": {
              "type": "string",
              "pattern": "^[A-Z]{2}$",
              "description": "Entity formation country"
            },
            "BENEFICIARY_OWNERSHIP": {
              "type": "boolean",
              "description": "Whether any individuals or intermediaries own 25% or more of the company"
            },
            "AUTHORIZED_SIGNATORIES": {
              "ref": "#/$defs/individual"
            },
            "METHOD_OF_VERIFICATION": {
              "type": "string",
              "description": "Verification method used"
            },
            "NATIONAL_IDENTIFICATION_NUMBER": {
              "type": "string",
              "description": "Business identification number (e.g., Tax ID)"
            },
            "INTERMEDIARY_BENEFICIARY_OWNERS": {
              "ref": "#/$defs/intermediaryBeneficiaryOwner"
            }
          },
          "description": "RFI Data Requirements"
        }
      },
      "fileRequirements": [
        "FORMATION_DOCUMENT"
      ]
    },
    "rfis": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "status": "APPROVED"
      }
    ],
    "onChainTransactions": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "status": "PENDING"
      }
    ],
    "fiatSettlementTime": {
      "max": "3",
      "min": "1",
      "unit": "DAYS"
    },
    "refunds": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "status": "CREATED",
        "amount": {
          "amount": "110.270000",
          "currency": "USDC"
        },
        "transactionHash": "<string>"
      }
    ],
    "metadata": {},
    "statusAddendum": "IN_MANUAL_REVIEW"
  }
}

Authorizations

Authorization

string

header

required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Body

application/json

Request body for creating a new payment transaction

quoteId

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

idempotencyKey

string<uuid>

required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to uuidgenerator.net. If the same key is reused, it will be treated as the same request and the original response will be returned.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

beneficiaryAccountData

string<jwe>

required

A JSON Web Encryption (JWE) compact string format as defined in RFC 7516

Example:

"eyJhbGciOiJFQ0RILUVTK0ExMjhLVyIsImVuYyI6IkExMjhHQ00iLCJlcGsiOnsiY3J2IjoiUC0yNTYiLCJrdHkiOiJFQyIsIngiOiI1TEtTbUtsNmVYV0dQNHlGb2tVaks4RGppU0l5YWpQdzJ6UUp1YVhFbEZzIiwieSI6IlRVT29MTV8wc294b0UzYVFmSExlUzRlRkZ3RU9tZ1VDRUh1eDVRMXdVYTQifX0.kVGnfB8eIqxq3bMvhedxUmZvkCrRfQOy.bTUOc_ilvZjb9VYP.pOS6Ul8Jnp_pijWtaQYC0b1NLN1Nc-t_MTsfj5EZy6s62ijQWGtAoo3enwx3gOpXIQDIIF7c-F3KSrVO33a5RIF8a4tvU7pRk_JDKVgHFVpSzvOaUHNHsMUvvctAncx1SneVE_gnm5ATkWO4_1i7irTkb-cjWLmvJ1vVEyJiC9ZgsEdK_eBAewpZTyyKxvoxBpo8IZ3g7qax712TvMsNpIJ_faQmsyRKwt2kBxDPyrWILcIvS1qij6uVOsEP2R6LXbWfBqVbklsgNPWjndXSmOJmsTdBjFzublMLSHmLxkfaD9gt3DxgD16rqDlKO9KmaRF3r322VumP4hrlfOsZUHHcVGeTpgjZwI9jrj76PiYtyCOeR7-kz97PamqrOQAfWRE8Rcp8QdCO6yFHFe3N2pI5kWakH783DVDAsm_x2VY_V8vCDe-xkIoJOabx3LqaxHq8_x_ATXZ01NX-5F9VqgtE73FOIGhinxt8G-Kfxvdlx6gv-QSfBvigVuoR1OCSPNB3OHirEKXY3IjWnjZuENNnXl9CqrCsHQZS1eb1KcaIkg_2NF6gi54htX6ijpUtyXS03IGZW6Bn6CSWqmmvMStIAIYO-8ZJrrleeCfU6WY5KjFlIvN6th-tE41JNJWS9mVqhjzwPC7GQ5bGkqq2zJKhALOuN_0oG4jXOYo1s3YAn-xw3kpq46fYyUrX4nLSocaKDeKOMMqh57_jcMDmHrXdmjlHGPMrBPdU_deub121c3ofTKgJg4KRC8mcTYcXe71uflARAr24msd9A_IPPVbhfvs06HOVKL2-jK6r_WL_9vWU3q-OPQHU3eWUOhI18vZ0CkGqJjtEKyBBmc4inWEbrsO02P2Zd5VTBCIoAaNrpY6n5mNyKPo6-PyrxNy27d6u2yoZvjG6QSuUO9DaX4AyGsE87agh_XgLW9RPXfcZQ7F5aUCQwEA0cF9YSEaYYBGziS7oQ99D1th1MQqEPcFxD5YPdyaPykU3Zbf5T8HSZz1risMbgQu97eXoarxm801pdw5cuKijqj39BVrgdLUfaQ9P-iGWcVJk8ZVXfHK3JHGaBuIjYNIy5lHF3TsKgV2x-wWxqER9vPdgejAGirkxHQaKPt2rg0rmbk3R7YTibT7yTKwO1PRiewi0lxKWvZqDbCoedyuYZCR0vup4S1ZVYX6uGBn-F5ODrnLoAZTbnV1tjDJgxFpA8EKsXWTrc78XH0715lY2OnbDtBOLMbxFJjK1_YDRU2UMkZTEx5BrhR4YibBd4-BCZT-dWTxanOHMxTKl823tyggY5lBQ8DlsLj1qZpOxKWYTM8WrLCZa7vZo9FmXw38FxYrqbwespe7xdS7onfmlI4Ug92eTtZ31FbZfcqOiAGgH9Etkj1M9scP0is6zVC6cIUQzC3NmHNxNtPv6XjMUWigijosvs7x9-qyVCqzJZlEGck2BJ6Uk7ug9QKcxHtaWgtuHPnA77KVE3Vi_dikYaXzxIdgjrGtqqUhXEhrAFkesvJ0UeH1ac94e-R8UrJX75w4DDoRyaFxQhDFdHVtD0ceVN7ekYJkmoS2eSAzWDwsKUvUrmafcfpQ922tZGq0RvnMh39SWy6I6xRFyYHarra24Gbawa5_THjB8TkHJ180giPC3KQAa_6Vz8CP-fks6_-MdGXPW0SYhNghNi_14ZXQ3rZYHaTICgeHhBfhJ4MQ6OlRkiRCrIkM5WSOTS_H715aeyUCL-dlZ0TiG2DpAIXkN1KMRp0jL_W12pg5SjKFAlOGnQgkgj9rO_C7pLxMyIhgEUKPHXMGN6Q7tpVhAAyTl0tabd7cvyWnf5L4UiyIpvb1qrt1bY6-VNA4KXz6Y5uiiBYFF_FIN3K6YZCT4l0zuh_gxmP9eba7zM5kgas1tr1IxYWI-mQiE9Rb8rX0hqXpMj27h9Mf_Sn56TJeEmW8d8x2Xy2Nb7KU9vQO-6uc_taXP0Lv5LFcSwZkdVe7FOeZD-GoaNDly9MdhXI4ELP4MOZXZFJeN7aCJvJeLRBPWnoM2aazDwtlA_KfhZVFtCsKKjJazv6J9h6CDHAm7NuexVJiPdtS1yknQDWrIBfneaLJasmtuhuAbRPtiTvvhQOXt51q0G7sjCSmmeNMwb5fFphe4wLJNmsbdgMFDcUVzb0ImIArCxqBEEK8uuRGcYaRifaLv0zkk29NAT99Ux580zaeN_x7aIMpJTt7jLP0-HZ-QU3MAGg3PLJ3_Oly6ABoULkEkmRhF0TtpU8z-kmmN6FtmzZK74kYEC75smgVTnnJK1kBdsZw9cxHeUx8aDJGrS3OK-uYN0dPJls2LC7X1rHD7ES179nPVBeJA2REm-jSlhVlV_I7JrVzlcXs0Fhx0hX-OgMKz_yQNHnM6RbgGnSLDcvND7vXqkEMgHeDRomhU1hMeu0DymctTKawtzIkV7MYwoibLDUeMvaXN8MicMs64D8I3Ld7BLtFf9o8rMeeNJ0Om7xdl9SGD2RYAep0cxw2rEIIr859e1vutBuvrrMz09dZKd05t1lu0jRztkQzUW9N-VZh9muTAoh_s3NrF2ZTFnRAfzxohwNLxxmX-Ov94FXBhuRHBQXb931I5m2URglrYcoAZ8RFoiAWW2AkHcyb5PRoQIt-LQhOM-bcn1VB44Okh10jqWpGbLno6AvE5FcoRVcspb0tor9EbksW2cipoypcaat5NhQgvo2rAPmkHGi8iB-z_xWORvUkaA2xknNW59myO6qTvjYQ_1P1ESbRO30nUeqgP3VoZrC1-bi9IbgSi-na31xEhdr-ZGuvtRSzyhWwqfviJgSMZ6_kkGW3gUI4ldurTwss6gDHWYmdV-lHtPMfYuD2KMQk1EyJ-3vZx0syLKDACL37HqAYvkW5GiOxrK9cNrSInQ8rZMDkXsaCZMEtvs03Qw2DyCBdoFeXPvFHJ6Vetou-7Oo6rdlmSkt5KdA-w9KKVIAt9WtYxNc-wjFm-vOMcOHb_xxzacDzYFJj8NxdW8GaVdrCvh3j5Yakr_3vSvRM5rpzQKMqw-B53SWV3oOHYu29qso5zSTz-dvAlZUL8Z1a3s13qdwhUkkRexIi6oTU0Da21pT-gCan2jSY_VKR8JdirKTLocn74JZ3InF8iH8XhOD0X7ySIbB69HqMLYRd9r13q2odfJ3cN1CWSF71zgIuZoYSbkO9DeFvCImA-WEIWrP1kJiYlpJi8VnFNQs8XWIxdCydft-8zvoXZbi0MoNt3kJExbKx7dReHx6B-6iwjuW8-o5RbeMvdTIYTp-y6YPsFhcVCvTlS7IefXqG4G3OrnNc5JIVnvdYXWCWUdWguiKdqB6FL_LSWOtsWrB6nIv69WP1WJJSa0Oa_EkxEwXK1BGH9-QpMqkP6rATSvsbaTywfCxqUqm7SzYH81lSCIvI5J7bWX5blk9rNZbp3aSeEpVRm03vwLrgUHLv9vMAopNnw5fZGKfcg3I5ZWYHNQo5BZk9LVpebMBYGijwNDnuFu08eF7ShlEzy50NsvgeDxZtfUVx8cviYn0MoTJBPlz1mXRSIr3zDIpefxDGnsQ1KK8LTi0Gbnt_ybeiT4yTmajrPLE4566D6AQIdDmCg_RsBtB_lAw.S2qu0MNMu2WNiEYoHh25ww"

travelRuleData

string<jwe>

required

A JSON Web Encryption (JWE) compact string format as defined in RFC 7516

Example:

customerRefId

string

required

Reference or description used to identify the object.

Example:

"custom_ref_id"

useCase

enum<string>

required

The type of payment use case

Available options:

B2B,

B2C,

C2C,

C2B

Example:

"B2B"

reasonForPayment

enum<string>

required

The reason code for the payment. For more details see Payment Reason Codes.

Available options:

PMT001,

PMT002,

PMT003,

PMT004,

PMT005,

PMT006,

PMT007,

PMT008,

PMT009,

PMT010,

PMT011,

PMT012,

PMT013,

PMT014,

PMT015,

PMT016,

PMT017,

PMT018,

PMT019,

PMT020,

PMT021,

PMT022,

PMT023,

PMT024,

PMT025,

PMT026,

PMT027,

PMT028,

PMT029,

PMT030

Example:

"PMT001"

senderAddress

string

required

The OFI wallet address.

Example:

"0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c"

blockchain

enum<string>

required

Supported blockchain networks

Available options:

SOL,

MATIC,

ETH,

SOL-DEVNET,

MATIC-AMOY,

ETH-SEPOLIA

Example:

"ETH-SEPOLIA"

refundAddress

string

required

The wallet address where funds will be returned if a payment fails. This address must be on the same blockchain as the original sender's address. The refundAddress can be different from senderAddress.

Example:

"0x7d9f3f9c2b7e4c0a5a9f3e8b4d2c1a0f5e6d7c8b"

beneficiaryRefId

string

Reference or description used to identify the object.

Example:

"custom_ref_id"

refCode

string

Reference or description used to identify the object.

Example:

"custom_ref_id"

Response

Payment created successfully.

data

object

required

Response schema for a payment containing all payment details including source and destination amounts, fees, status, and related transactions

Show child attributes

data.id

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.quoteId

string

required

Reference or description used to identify the object.

Example:

"custom_ref_id"

data.paymentMethodType

enum<string>

required

The method used for the payment (e.g., PIX, WIRE, CHATS)

Available options:

AANI,

BANK-TRANSFER,

CHATS,

CIPS,

FAST,

FPS,

FTS,

IMPS,

INSTA-PAY,

NEFT,

NEQUI,

PESONET,

PIX,

RTGS,

SEPA,

SPEI,

WIRE

Example:

"SPEI"

data.blockchain

enum<string>

required

Supported blockchain networks

Available options:

SOL,

MATIC,

ETH,

SOL-DEVNET,

MATIC-AMOY,

ETH-SEPOLIA

Example:

"ETH-SEPOLIA"

data.senderAddress

string

required

A blockchain address that can be used to send or receive transactions on a blockchain network.

Example:

"0xe01be9cdd9e744ae6a709794bfe531ec3ec0671c"

data.refCode

string

required

Reference or description used to identify the object.

Example:

"custom_ref_id"

data.customerRefId

string

required

Reference or description used to identify the object.

Example:

"custom_ref_id"

data.expireDate

string<date-time>

required

Date and time when the resource expires

Example:

"2023-01-01T12:04:05Z"

data.createDate

string<date-time>

required

Date and time when the resource was created

Example:

"2023-01-01T12:04:05Z"

data.status

enum<string>

required

The current status of a payment

Available options:

CREATED,

CRYPTO_FUNDS_PENDING,

FIAT_PAYMENT_INITIATED,

COMPLETED,

FAILED

Example:

"COMPLETED"

data.useCase

enum<string>

required

The type of payment use case

Available options:

B2B,

B2C,

C2C,

C2B

Example:

"B2B"

data.reasonForPayment

enum<string>

required

The reason code for the payment. For more details see Payment Reason Codes.

Available options:

PMT001,

PMT002,

PMT003,

PMT004,

PMT005,

PMT006,

PMT007,

PMT008,

PMT009,

PMT010,

PMT011,

PMT012,

PMT013,

PMT014,

PMT015,

PMT016,

PMT017,

PMT018,

PMT019,

PMT020,

PMT021,

PMT022,

PMT023,

PMT024,

PMT025,

PMT026,

PMT027,

PMT028,

PMT029,

PMT030

Example:

"PMT001"

data.sourceAmount

object

required

Represents an amount of cryptocurrency, including both the numerical amount and the specific cryptocurrency type.

Show child attributes

data.sourceAmount.amount

string

Example:

"110.270000"

data.sourceAmount.currency

enum<string>

Supported cryptocurrencies

Available options:

USDC

Example:

"USDC"

Example:

{
  "amount": "110.270000",
  "currency": "USDC"
}

data.destinationAmount

object

required

Represents an amount of money in a specific fiat currency, including both the numerical amount and the currency type.

Show child attributes

data.destinationAmount.amount

string

Example:

"183.24"

data.destinationAmount.currency

enum<string>

Supported fiat currencies

Available options:

BRL,

CNY,

COP,

EUR,

GBP,

HKD,

INR,

MXN,

NGN,

USD

Example:

"MXN"

data.fees

object

required

A collection of fees associated with a payment transaction, including both individual fee breakdowns and the total amount.

Show child attributes

data.fees.breakdown

object[]

Detailed breakdown of individual fees that make up the total payment fees.

Show child attributes

data.fees.breakdown.amount

object

Represents an amount of cryptocurrency, including both the numerical amount and the specific cryptocurrency type.

Show child attributes

data.fees.breakdown.amount.amount

string

Example:

"110.270000"

data.fees.breakdown.amount.currency

enum<string>

Supported cryptocurrencies

Available options:

USDC

Example:

"USDC"

Example:

{
  "amount": "110.270000",
  "currency": "USDC"
}

data.fees.breakdown.type

enum<string>

The type of fee being charged for the transaction.

Available options:

TAX_FEE,

BFI_TRANSACTION_FEE

Example:

"BFI_TRANSACTION_FEE"

data.fees.totalAmount

object

Represents an amount of cryptocurrency, including both the numerical amount and the specific cryptocurrency type.

Show child attributes

data.fees.totalAmount.amount

string

Example:

"110.270000"

data.fees.totalAmount.currency

enum<string>

Supported cryptocurrencies

Available options:

USDC

Example:

"USDC"

Example:

{
  "amount": "110.270000",
  "currency": "USDC"
}

data.beneficiaryRefId

string

Reference or description used to identify the object.

Example:

"custom_ref_id"

data.fiatNetworkPaymentRef

string

Reference or description used to identify the object.

Example:

"custom_ref_id"

data.failureReason

enum<string>

Available options:

TRAVEL_RULE_FAILED,

BANK_VERIFICATION_FAILED,

RFI_VERIFICATION_FAILED,

EXISTING_RFI_PENDING,

ONCHAIN_SETTLEMENT_FAILED,

COMPLIANCE_CHECK_FAILED,

CANCELLED,

PAYMENT_EXPIRED,

OTHER

Example:

"CANCELLED"

data.failureCode

string

The code for the detailed description of the payment failure reason. For more details see Payment Failure Codes.

Example:

"PM01001"

data.activeRfi

object

Response schema for Request for Information (RFI) details

Show child attributes

data.activeRfi.id

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.activeRfi.paymentId

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.activeRfi.status

enum<string>

required

Status of the RFI (Request for Information)

Available options:

INFORMATION_REQUIRED,

IN_REVIEW,

APPROVED,

REJECTED

Example:

"APPROVED"

data.activeRfi.level

enum<string>

required

Level of the RFI (Request for Information)

Available options:

LEVEL_1,

LEVEL_2,

LEVEL_3

Example:

"LEVEL_1"

data.activeRfi.expireDate

string<date-time>

required

Date and time when the resource expires

Example:

"2023-01-01T12:04:05Z"

data.activeRfi.certificate

object

Show child attributes

data.activeRfi.certificate.id

string<uuid>

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.activeRfi.certificate.certPem

file

Base64 encoded certificate in PEM format

Example:

"LS0tLS1CRUdJT..."

data.activeRfi.certificate.domain

string

BFI domain which is available in the CommonName attribute of the cert

Example:

"api.circle.com"

data.activeRfi.certificate.jwk

object

The public key for the BFI defined in RFC 7517

Show child attributes

data.activeRfi.certificate.jwk.crv

string

The curve used for the EC key

Example:

"P-256"

data.activeRfi.certificate.jwk.kid

string

Key ID

Example:

"263521881931753643998528753619816524468853605762"

data.activeRfi.certificate.jwk.kty

string

Key type

Example:

"EC"

data.activeRfi.certificate.jwk.x

string

X coordinate for the EC public key

Example:

"KnxBe8fb2mL_Ve9-tqjGSkGgE9f0yohMkAvH_InaFtE"

data.activeRfi.certificate.jwk.y

string

Y coordinate for the EC public key

Example:

"D41cVUpiKcey4LJKNFtUtmVHDWRmhjZapPLfryX5b1o"

data.activeRfi.fieldRequirements

object

Show child attributes

data.activeRfi.fieldRequirements.version

integer

Version of the RFI requirement schema provided by CPN.

Example:

1

data.activeRfi.fieldRequirements.schema

object

JSON schema for the RFI requirements. Note that references use 'ref' instead of '$ref' to avoid YAML parsing issues.

Example:

{
  "type": "object",
  "$defs": {
    "address": {
      "type": "object",
      "required": ["street", "city", "country"],
      "properties": {
        "city": {
          "type": "string",
          "description": "City name"
        },
        "street": {
          "type": "string",
          "description": "Street address"
        },
        "country": {
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "description": "Country code (e.g., US, GB)"
        },
        "postalCode": {
          "type": "string",
          "description": "Postal or ZIP code"
        },
        "stateProvince": {
          "type": "string",
          "description": "State or province"
        }
      },
      "description": "Full address"
    },
    "individual": {
      "type": "object",
      "required": ["name", "address", "dateOfBirth"],
      "properties": {
        "name": {
          "type": "string",
          "description": "Individual's full name"
        },
        "address": { "ref": "#/$defs/address" },
        "dateOfBirth": {
          "type": "string",
          "format": "date",
          "description": "Individual's date of birth (YYYY-MM-DD)"
        }
      },
      "description": "Individual's RFI data"
    },
    "beneficiaryOwner": {
      "type": "object",
      "required": [
        "name",
        "address",
        "dateOfBirth",
        "percentage"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Individual's full name"
        },
        "address": { "ref": "#/$defs/address" },
        "percentage": {
          "type": "number",
          "description": "Company ownership percentage"
        },
        "dateOfBirth": {
          "type": "string",
          "format": "date",
          "description": "Individual's date of birth (YYYY-MM-DD)"
        }
      },
      "description": "Beneficiary owner's RFI data"
    },
    "intermediaryBeneficiaryOwner": {
      "type": "object",
      "required": [
        "name",
        "address",
        "dateOfFormation",
        "countryOfFormation",
        "percentage"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Business legal name"
        },
        "address": { "ref": "#/$defs/address" },
        "percentage": {
          "type": "number",
          "description": "Company ownership percentage"
        },
        "dateOfFormation": {
          "type": "string",
          "format": "date",
          "description": "Company formation date (YYYY-MM-DD)"
        },
        "countryOfFormation": {
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "description": "Entity formation country"
        }
      },
      "description": "Intermediary beneficiary owner's RFI data"
    }
  },
  "title": "RFI Requirements",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "SOURCE_OF_FUNDS",
    "METHOD_OF_VERIFICATION",
    "NAME",
    "TRADE_NAME",
    "NATIONAL_IDENTIFICATION_NUMBER",
    "DATE_OF_FORMATION",
    "COUNTRY_OF_FORMATION",
    "ENTITY_TYPE",
    "INDUSTRY_TYPE",
    "ADDRESS",
    "AUTHORIZED_SIGNATORIES",
    "BENEFICIARY_OWNERSHIP"
  ],
  "properties": {
    "NAME": {
      "type": "string",
      "description": "Business legal registered name"
    },
    "EMAIL": {
      "type": "string",
      "description": "Business contact email address"
    },
    "PHONE": {
      "type": "string",
      "description": "Business contact phone number"
    },
    "ADDRESS": { "ref": "#/$defs/address" },
    "WEBSITE": {
      "type": "string",
      "description": "Business website URL"
    },
    "TRADE_NAME": {
      "type": "string",
      "description": "Business trade name or DBA (Doing Business As)"
    },
    "ENTITY_TYPE": {
      "type": "string",
      "description": "Business structure type (Corporation, LLC, Partnership, etc.)"
    },
    "INDUSTRY_TYPE": {
      "type": "string",
      "description": "Business activity classification"
    },
    "SOURCE_OF_FUNDS": {
      "type": "string",
      "description": "Transaction source of funds"
    },
    "DATE_OF_FORMATION": {
      "type": "string",
      "format": "date",
      "description": "Company formation date (YYYY-MM-DD)"
    },
    "BENEFICIARY_OWNERS": { "ref": "#/$defs/beneficiaryOwner" },
    "COUNTRY_OF_FORMATION": {
      "type": "string",
      "pattern": "^[A-Z]{2}$",
      "description": "Entity formation country"
    },
    "BENEFICIARY_OWNERSHIP": {
      "type": "boolean",
      "description": "Whether any individuals or intermediaries own 25% or more of the company"
    },
    "AUTHORIZED_SIGNATORIES": { "ref": "#/$defs/individual" },
    "METHOD_OF_VERIFICATION": {
      "type": "string",
      "description": "Verification method used"
    },
    "NATIONAL_IDENTIFICATION_NUMBER": {
      "type": "string",
      "description": "Business identification number (e.g., Tax ID)"
    },
    "INTERMEDIARY_BENEFICIARY_OWNERS": {
      "ref": "#/$defs/intermediaryBeneficiaryOwner"
    }
  },
  "description": "RFI Data Requirements"
}

data.activeRfi.fileRequirements

enum<string>[]

File Key for RFI (Request for Information)

Available options:

FORMATION_DOCUMENT,

ORG_STRUCTURE,

INVOICE,

BENEFICIARY_OWNERS_DOCUMENT,

ID_DOCUMENT,

PROOF_OF_ADDRESS_DOCUMENT,

ADDITIONAL_DOCUMENTS

data.rfis

object[]

Array of all rfi ids related to payment.

Show child attributes

data.rfis.id

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.rfis.status

enum<string>

required

Status of the RFI (Request for Information)

Available options:

INFORMATION_REQUIRED,

IN_REVIEW,

APPROVED,

REJECTED

Example:

"APPROVED"

data.onChainTransactions

object[]

Array of on chain transactions related to the payments.

Show child attributes

data.onChainTransactions.id

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.onChainTransactions.status

enum<string>

required

Lifecycle status of a transaction

Available options:

CREATED,

PENDING,

BROADCASTED,

COMPLETED,

FAILED

Example:

"PENDING"

data.fiatSettlementTime

object

Estimated time range for when funds will arrive at their destination after a transfer is initiated. The time varies depending on the fiat payment method used (e.g., ACH, SEPA, Wire). The time is represented as a range with minimum and maximum values in the specified unit.

Show child attributes

data.fiatSettlementTime.max

string

Example:

"3"

data.fiatSettlementTime.min

string

Example:

"1"

data.fiatSettlementTime.unit

enum<string>

Available options:

MINUTES,

HOURS,

DAYS,

WEEKS

Example:

"DAYS"

data.refunds

object[]

Array of all refunds related to payment.

Show child attributes

data.refunds.id

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.refunds.status

enum<string>

required

Refund status.

Available options:

CREATED,

COMPLETED,

FAILED

data.refunds.amount

object

Represents an amount of cryptocurrency, including both the numerical amount and the specific cryptocurrency type.

Show child attributes

data.refunds.amount.amount

string

Example:

"110.270000"

data.refunds.amount.currency

enum<string>

Supported cryptocurrencies

Available options:

USDC

Example:

"USDC"

Example:

{
  "amount": "110.270000",
  "currency": "USDC"
}

data.refunds.transactionHash

string | null

Transaction hash if refund has been sent onchain.

data.metadata

object

Key-value pairs for storing reference data. Up to 50 keys allowed, with key names up to 40 characters and values up to 500 characters.

Show child attributes

data.metadata.{key}

string

Metadata value

Maximum string length: 500

data.statusAddendum

enum<string>

Additional context about the payment status.

Available options:

IN_MANUAL_REVIEW,

PAYMENT_SETTLEMENT_DELAYED

List payments

Get payment requirements for a quote

API Overview

Circle Payments Network

Create a payment

Authorizations

Body

Response