---
updatedAt: 2025-06-12T23:59:34.000Z
agentTools:
  projectIndex: https://docs.fiatrepublic.com/llms.txt
---

# Create Payin

Create a `COMPLETED` Payin on Sandbox to simulate the behaviour of Payins received from external bank accounts in the live environment. Payins created via this endpoint will also trigger events to relevant webhooks.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "fiat-republic",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://sandbox.fiatrepublic.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/simulator/payment": {
      "post": {
        "summary": "Create Payin",
        "description": "Create a `COMPLETED` Payin on Sandbox to simulate the behaviour of Payins received from external bank accounts in the live environment. Payins created via this endpoint will also trigger events to relevant webhooks.",
        "operationId": "create-payin",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "amount",
                  "from",
                  "paymentScheme",
                  "reference",
                  "toId"
                ],
                "properties": {
                  "amount": {
                    "type": "string",
                    "description": "Amount of the payment."
                  },
                  "from": {
                    "type": "object",
                    "description": "Details of the Payer from who you want to simulate the payment.",
                    "required": [
                      "type",
                      "name"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "description": "Type of the Payer.",
                        "enum": [
                          "PERSON",
                          "BUSINESS"
                        ]
                      },
                      "name": {
                        "type": "string",
                        "description": "Name of the Payer."
                      },
                      "bankDetails": {
                        "type": "object",
                        "description": "Bank Details of the Payer.",
                        "properties": {
                          "accountNumber": {
                            "type": "string"
                          },
                          "bic": {
                            "type": "string"
                          },
                          "iban": {
                            "type": "string"
                          },
                          "routingCodes": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string",
                                "description": "Type of the routing code. Either SORT_CODE or BSB",
                                "enum": [
                                  "SORT_CODE",
                                  "BSB"
                                ]
                              },
                              "value": {
                                "type": "string",
                                "description": "Value of the routing code."
                              }
                            }
                          },
                          "bankName": {
                            "type": "string"
                          },
                          "bankAddressLine1": {
                            "type": "string",
                            "description": "First line of Bank's address."
                          },
                          "bankAddressCity": {
                            "type": "string",
                            "description": "City"
                          },
                          "bankAddressPostalCode": {
                            "type": "string",
                            "description": "Postal/Zip code"
                          },
                          "bankAddressState": {
                            "type": "string"
                          },
                          "bankAddressCountry": {
                            "type": "string",
                            "description": "Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom"
                          },
                          "bankCountry": {
                            "type": "string",
                            "description": "Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom"
                          }
                        }
                      },
                      "additionalDetails": {
                        "type": "object",
                        "description": "Address details of the Payer.",
                        "properties": {
                          "addressCity": {
                            "type": "string"
                          },
                          "addressLine1": {
                            "type": "string"
                          },
                          "addressLine2": {
                            "type": "string"
                          },
                          "addressCountry": {
                            "type": "string"
                          },
                          "addressPostalCode": {
                            "type": "string",
                            "description": "Two-letter ISO 3166-1 alpha-2 country code e.g. GB for United Kingdom"
                          }
                        }
                      }
                    }
                  },
                  "paymentScheme": {
                    "type": "string",
                    "description": "Payment Scheme of the incoming payment you want to simulate.",
                    "enum": [
                      "FPS",
                      "CHAPS",
                      "SCT"
                    ]
                  },
                  "reference": {
                    "type": "string",
                    "description": "Reference on the incoming payment. e.g. `deposit`."
                  },
                  "toId": {
                    "type": "string",
                    "description": "Id of the destination of the payment. Destination can be a Fiat Account or a Payee."
                  }
                }
              },
              "examples": {
                "GBP Example": {
                  "value": {
                    "from": {
                      "type": "PERSON",
                      "name": "John Doe",
                      "bankDetails": {
                        "routingCodes": [
                          {
                            "type": "SORT_CODE",
                            "value": "401276"
                          }
                        ],
                        "accountNumber": "12345658",
                        "bankName": "Hsbc Uk Bank Plc",
                        "bankCountry": "GB"
                      }
                    },
                    "toId": "vac_5opkx8g1jo50lz4m3e",
                    "amount": "1000",
                    "paymentScheme": "FPS",
                    "reference": "Simulate Deposit"
                  }
                },
                "EUR Example": {
                  "value": "{\n  \"from\": {\n    \"type\": \"PERSON\",\n    \"name\": \"John Doe\",\n    \"bankDetails\": {\n        \"bankName\": \"BANKING CIRCLE S.A.\",\n        \"bankAddressLine1\": \"2 boulvard de la foire\",\n        \"bankAddressCity\": \"Luxembourg\",\n        \"bankAddressPostalCode\": \"1528\",\n        \"bankAddressState\": null,\n        \"bankAddressCountry\": \"LU\",\n        \"iban\": \"LU254080000024546498\",\n        \"bic\": \"BCIRLULLXXX\",\n        \"bankCountry\": \"LU\"\n    }\n    \"metadata\": null\n  },\n  \"toId\": \"fac_01010101010101\",\n  \"amount\": \"1000\",\n  \"paymentScheme\": \"SCT\",\n  \"reference\": \"Custom reference here\"\n}"
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "202",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": ""
                  }
                }
              }
            }
          },
          "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
}
```