Skip to main content
POST
/
v1
/
payments
/
{payment_id}
/
approve-allocations
Approve Allocations
curl --request POST \
  --url http://api.stuut.ai/v1/payments/{payment_id}/approve-allocations \
  --header 'Authorization: Bearer <token>'
{
  "amount": 123,
  "currency": "ADP",
  "object": "<string>",
  "partner_id": "<string>",
  "status": "pending_match",
  "timestamp": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "agent_confidence_reason": "<string>",
  "agent_confidence_score": 123,
  "agent_error_code": "<string>",
  "agent_uncertainties": [
    "<string>"
  ],
  "allocations": [
    {
      "amount": 123,
      "invoice_id": "<string>",
      "object": "<string>",
      "payment_id": "<string>",
      "strategy": "automatic",
      "id": "<string>",
      "agent_confidence_reason": "<string>",
      "agent_confidence_score": 123,
      "agent_error_code": "<string>",
      "agent_uncertainties": [
        "<string>"
      ],
      "approved": true,
      "approved_at": "2023-11-07T05:31:56Z",
      "approver_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "invoice": {
        "amount_due": 123,
        "currency": "<string>",
        "id": "<string>",
        "amount_paid": 123,
        "due_date": "2023-11-07T05:31:56Z",
        "number": "<string>"
      },
      "modified_at": "2023-11-07T05:31:56Z",
      "remote_id": "<string>"
    }
  ],
  "amount_refunded": 123,
  "bank_transaction": {
    "account_id": "<string>",
    "amount": 123,
    "object": "<string>",
    "posted": true,
    "reference_number": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "type": "deposit",
    "id": "<string>",
    "account_mask": "<unknown>",
    "authorized_at": "2023-11-07T05:31:56Z",
    "check_number": "<string>",
    "counterparty_email": "<string>",
    "counterparty_logo": "<string>",
    "counterparty_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "currency": "ADP",
    "currency_rate": 123,
    "custom_fields": "<unknown>",
    "description": "<string>",
    "description_details": "<unknown>",
    "invoice_numbers": [
      "<string>"
    ],
    "is_draft": true,
    "last_synced_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "partner": {
      "id": "<string>",
      "account_number": "<string>",
      "ap_portals": [
        {
          "object": "<string>",
          "partner_id": "<string>",
          "id": "<string>",
          "account": {
            "object": "<string>",
            "organization_id": "<string>",
            "provider": "coupa",
            "id": "<string>",
            "available_operations": "<unknown>",
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z"
          },
          "account_id": "<string>",
          "account_key": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "customer_identifier": "<string>",
          "customer_name": "<string>",
          "invoice_submission_guidelines": "<string>",
          "is_enabled": true,
          "is_invoice_submission_enabled": true,
          "is_report_download_enabled": true,
          "modified_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "provider": "coupa",
          "report_email": "<string>",
          "report_frequency": "daily"
        }
      ],
      "assignee": {
        "email": "<string>",
        "family_name": "<string>",
        "given_name": "<string>",
        "object": "<string>",
        "organization_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "dashboard_settings": {
          "thread_emails_sort_order": "asc"
        },
        "default_email_sender_id": "<string>",
        "invited_by_user_id": "<string>",
        "is_access_approved": true,
        "is_org_admin": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "onboarding_required": true,
        "profile_picture": "<string>",
        "selected": true
      },
      "assignee_id": "<string>",
      "billing_address": {
        "object": "<string>",
        "city": "<string>",
        "coordinates": {},
        "country": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "phone": "<string>",
        "postal_code": "<string>",
        "remote_id": "<string>",
        "state": "<string>",
        "type": "<string>"
      },
      "billing_address_id": 123,
      "contacts": [
        {
          "email": "<string>",
          "object": "<string>",
          "partner_id": "<string>",
          "id": "<string>",
          "address": {
            "object": "<string>",
            "city": "<string>",
            "coordinates": {},
            "country": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "description": "<string>",
            "line1": "<string>",
            "line2": "<string>",
            "modified_at": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "phone": "<string>",
            "postal_code": "<string>",
            "remote_id": "<string>",
            "state": "<string>",
            "type": "<string>"
          },
          "address_id": 123,
          "addresses": [
            {
              "object": "<string>",
              "id": "<string>",
              "city": "<string>",
              "coordinates": {},
              "country": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "description": "<string>",
              "is_primary": true,
              "line1": "<string>",
              "line2": "<string>",
              "modified_at": "2023-11-07T05:31:56Z",
              "name": "<string>",
              "postal_code": "<string>",
              "state": "<string>",
              "type": "<string>"
            }
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "custom_fields": "<unknown>",
          "external_role": "billing_contact",
          "family_name": "<string>",
          "given_name": "<string>",
          "internal_role": "account_manager",
          "is_email_disabled": true,
          "is_phone_disabled": true,
          "is_primary": true,
          "is_primary_email": true,
          "is_primary_phone": true,
          "job_title": "<string>",
          "modified_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "phone": "<string>",
          "remote_created_at": "2023-11-07T05:31:56Z",
          "remote_id": "<string>",
          "remote_metadata": null,
          "remote_modified_at": "2023-11-07T05:31:56Z",
          "status_metadata": "<unknown>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "ADP",
      "custom_fields": "<unknown>",
      "description": "<string>",
      "email": "<string>",
      "family_name": "<string>",
      "finix_identity_id": "<string>",
      "given_name": "<string>",
      "invoice_prefix": "<string>",
      "is_active": true,
      "is_company": true,
      "is_email_disabled": true,
      "is_phone_disabled": true,
      "is_primary_email": true,
      "is_primary_phone": true,
      "last_outreach_at": "2023-11-07T05:31:56Z",
      "last_outreach_channel": "email",
      "last_outreach_to": "<string>",
      "last_synced_at": "2023-11-07T05:31:56Z",
      "legal_name": "<string>",
      "linked_integration": {
        "integration_name": "<string>",
        "is_configured": true,
        "object": "<string>",
        "settings": {},
        "id": "<string>",
        "api_subdomain": "<string>",
        "api_url": "<string>",
        "connection_info": null,
        "created_at": "2023-11-07T05:31:56Z",
        "credentials_expire_at": "2023-11-07T05:31:56Z",
        "health": {
          "status": "incomplete",
          "details": null,
          "message": null,
          "reason": null
        },
        "identity_info": null,
        "integration": {
          "display_name": "<string>",
          "name": "<string>",
          "object": "<string>",
          "api_base_url": "<string>",
          "api_documentation_url": null,
          "api_requires_subdomain": false,
          "auth_type": null,
          "categories": [
            "accounting"
          ],
          "color": null,
          "connection_guide_url": null,
          "connection_instructions": null,
          "connection_steps": [
            {
              "type": "fetch",
              "title": "<string>",
              "description": null,
              "endpoint": null,
              "fields": null,
              "post_auth": false
            }
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "description": null,
          "is_enabled": true,
          "logo": null,
          "logo_square": null,
          "modified_at": "2023-11-07T05:31:56Z",
          "settings": [
            {
              "key": "<string>",
              "type": "any",
              "choices": null,
              "description": null,
              "format": "text",
              "group": null,
              "guide_url": null,
              "is_editable": false,
              "is_required": true,
              "is_select": false,
              "label": null,
              "post_auth": false,
              "requires_load": false
            }
          ],
          "short_description": null
        },
        "is_running_setup": true,
        "is_sync_disabled": true,
        "is_webhooks_enabled": true,
        "models": [
          {
            "integration_schema_id": "<string>",
            "linked_integration_id": "<string>",
            "name": "<string>",
            "object": "<string>",
            "id": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "exclude_rule": {},
            "field_mappings": null,
            "health": {
              "status": "incomplete",
              "details": null,
              "message": null,
              "reason": null
            },
            "is_read_enabled": true,
            "is_webhooks_setup": true,
            "is_write_enabled": true,
            "last_sync": {
              "linked_model_id": "<string>",
              "object": "<string>",
              "run_id": "<string>",
              "id": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "entity_id": "<string>",
              "is_initial_sync": true,
              "is_one_off": true,
              "modified_at": "2023-11-07T05:31:56Z",
              "pagination": null,
              "run": {
                "object": "<string>",
                "id": "<string>",
                "completed_at": "2023-11-07T05:31:56Z",
                "created_at": "2023-11-07T05:31:56Z",
                "data": null,
                "event_id": "<string>",
                "modified_at": "2023-11-07T05:31:56Z",
                "output": null,
                "remote_id": "<string>",
                "stacktrace": "<string>",
                "started_at": "2023-11-07T05:31:56Z",
                "status": "scheduled"
              },
              "timerange_end": "2023-11-07T05:31:56Z",
              "timerange_start": "2023-11-07T05:31:56Z"
            },
            "last_sync_id": "<string>",
            "modified_at": "2023-11-07T05:31:56Z",
            "next_sync_at": "2023-11-07T05:31:56Z",
            "sync_requested": true
          }
        ],
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "owner_id": "<string>",
        "requires_setup": true,
        "username": "<string>",
        "webhook_listener_url": "<string>",
        "webhook_setup_error": "<string>"
      },
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "object": "<string>",
      "on_behalf_of": "<string>",
      "on_behalf_of_phone": "<string>",
      "organization_id": "<string>",
      "parent_id": "<string>",
      "phone": "<string>",
      "remote_created_at": "2023-11-07T05:31:56Z",
      "remote_id": "<string>",
      "remote_metadata": null,
      "remote_modified_at": "2023-11-07T05:31:56Z",
      "remote_parent_id": "<string>",
      "remote_payment_portal_url": "<string>",
      "shipping_address": {
        "object": "<string>",
        "city": "<string>",
        "coordinates": {},
        "country": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "phone": "<string>",
        "postal_code": "<string>",
        "remote_id": "<string>",
        "state": "<string>",
        "type": "<string>"
      },
      "status_metadata": "<unknown>",
      "sync_status": "partial",
      "tags": [
        {
          "object": "<string>",
          "partner_id": "<string>",
          "tag_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "is_manual": true,
          "modified_at": "2023-11-07T05:31:56Z",
          "tag": {
            "name": "<string>",
            "object": "<string>",
            "id": "<string>",
            "color": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "rule_condition": {}
          }
        }
      ],
      "tax_number": "<string>",
      "timezone": "Africa/Abidjan"
    },
    "partner_id": "<string>",
    "payment_method": "ach",
    "remote_created_at": "2023-11-07T05:31:56Z",
    "remote_id": "<string>",
    "remote_metadata": null,
    "remote_modified_at": "2023-11-07T05:31:56Z",
    "statement_id": "<string>",
    "sync_status": "partial",
    "transaction_code": "<string>"
  },
  "bank_transaction_id": "<string>",
  "billing_email": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency_rate": 123,
  "custom_fields": "<unknown>",
  "description": "<string>",
  "expected_at": "2023-11-07T05:31:56Z",
  "finix_transfer_id": "<string>",
  "initiated_at": "2023-11-07T05:31:56Z",
  "last_exported_at": "2023-11-07T05:31:56Z",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "linked_integration_id": "<string>",
  "modified_at": "2023-11-07T05:31:56Z",
  "partner": {
    "id": "<string>",
    "account_number": "<string>",
    "ap_portals": [
      {
        "object": "<string>",
        "partner_id": "<string>",
        "id": "<string>",
        "account": {
          "object": "<string>",
          "organization_id": "<string>",
          "provider": "coupa",
          "id": "<string>",
          "available_operations": "<unknown>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z"
        },
        "account_id": "<string>",
        "account_key": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "customer_identifier": "<string>",
        "customer_name": "<string>",
        "invoice_submission_guidelines": "<string>",
        "is_enabled": true,
        "is_invoice_submission_enabled": true,
        "is_report_download_enabled": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "provider": "coupa",
        "report_email": "<string>",
        "report_frequency": "daily"
      }
    ],
    "assignee": {
      "email": "<string>",
      "family_name": "<string>",
      "given_name": "<string>",
      "object": "<string>",
      "organization_id": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "dashboard_settings": {
        "thread_emails_sort_order": "asc"
      },
      "default_email_sender_id": "<string>",
      "invited_by_user_id": "<string>",
      "is_access_approved": true,
      "is_org_admin": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "onboarding_required": true,
      "profile_picture": "<string>",
      "selected": true
    },
    "assignee_id": "<string>",
    "billing_address": {
      "object": "<string>",
      "city": "<string>",
      "coordinates": {},
      "country": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "phone": "<string>",
      "postal_code": "<string>",
      "remote_id": "<string>",
      "state": "<string>",
      "type": "<string>"
    },
    "billing_address_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "currency": "ADP",
    "custom_fields": "<unknown>",
    "description": "<string>",
    "email": "<string>",
    "family_name": "<string>",
    "finix_identity_id": "<string>",
    "given_name": "<string>",
    "invoice_prefix": "<string>",
    "is_active": true,
    "is_company": true,
    "is_email_disabled": true,
    "is_phone_disabled": true,
    "is_primary_email": true,
    "is_primary_phone": true,
    "last_outreach_at": "2023-11-07T05:31:56Z",
    "last_outreach_channel": "email",
    "last_outreach_to": "<string>",
    "last_synced_at": "2023-11-07T05:31:56Z",
    "legal_name": "<string>",
    "modified_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "object": "<string>",
    "on_behalf_of": "<string>",
    "on_behalf_of_phone": "<string>",
    "organization_id": "<string>",
    "parent_id": "<string>",
    "phone": "<string>",
    "remote_created_at": "2023-11-07T05:31:56Z",
    "remote_id": "<string>",
    "remote_metadata": null,
    "remote_modified_at": "2023-11-07T05:31:56Z",
    "remote_parent_id": "<string>",
    "remote_payment_portal_url": "<string>",
    "shipping_address": {
      "object": "<string>",
      "city": "<string>",
      "coordinates": {},
      "country": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "phone": "<string>",
      "postal_code": "<string>",
      "remote_id": "<string>",
      "state": "<string>",
      "type": "<string>"
    },
    "status_metadata": "<unknown>",
    "sync_status": "partial",
    "tags": [
      {
        "object": "<string>",
        "partner_id": "<string>",
        "tag_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "is_manual": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "tag": {
          "name": "<string>",
          "object": "<string>",
          "id": "<string>",
          "color": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "rule_condition": {}
        }
      }
    ],
    "tax_number": "<string>",
    "timezone": "Africa/Abidjan"
  },
  "payment_method": "ach",
  "receipt_url": "<string>",
  "reference_number": "<string>",
  "remittance": {
    "object": "<string>",
    "id": "<string>",
    "agent_confidence_reason": "<string>",
    "agent_confidence_score": 123,
    "agent_error_code": "<string>",
    "agent_uncertainties": [
      "<string>"
    ],
    "allocations": [
      {
        "invoice_number": "<string>",
        "object": "<string>",
        "remittance_id": "<string>",
        "amount_discount": 123,
        "amount_paid": 123,
        "amount_withheld": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "invoice": {
          "amount_due": 123,
          "currency": "<string>",
          "id": "<string>",
          "amount_paid": 123,
          "due_date": "2023-11-07T05:31:56Z"
        },
        "invoice_id": "<string>",
        "modified_at": "2023-11-07T05:31:56Z"
      }
    ],
    "attachment": {
      "file_type": "audio",
      "mime_type": "<string>",
      "name": "<string>",
      "object": "<string>",
      "organization_id": "<string>",
      "id": "<string>",
      "content_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "disposition": "<string>",
      "is_verified": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "presigned_url": "<string>",
      "presigned_url_expires_at": "2023-11-07T05:31:56Z",
      "purpose": "<string>",
      "remote_id": "<string>",
      "size": 123,
      "src": "<unknown>",
      "user_id": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "currency": "ADP",
    "email": {
      "object": "<string>",
      "thread_id": "<string>",
      "id": "<string>",
      "attachments": [
        {
          "file_type": "audio",
          "mime_type": "<string>",
          "name": "<string>",
          "object": "<string>",
          "organization_id": "<string>",
          "id": "<string>",
          "content_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "disposition": "<string>",
          "is_verified": true,
          "modified_at": "2023-11-07T05:31:56Z",
          "presigned_url": "<string>",
          "presigned_url_expires_at": "2023-11-07T05:31:56Z",
          "purpose": "<string>",
          "remote_id": "<string>",
          "size": 123,
          "src": "<unknown>",
          "user_id": "<string>"
        }
      ],
      "author": {
        "email": "<string>",
        "family_name": "<string>",
        "given_name": "<string>",
        "object": "<string>",
        "organization_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "dashboard_settings": {
          "thread_emails_sort_order": "asc"
        },
        "default_email_sender_id": "<string>",
        "invited_by_user_id": "<string>",
        "is_access_approved": true,
        "is_org_admin": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "onboarding_required": true,
        "profile_picture": "<string>",
        "selected": true
      },
      "author_id": "<string>",
      "bcc": [
        "<string>"
      ],
      "body": "<string>",
      "bounced_addresses": [
        "<string>"
      ],
      "bulk_email_request_id": "<string>",
      "cc": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "custom_headers": "<unknown>",
      "direction": "inbound",
      "email_reason": "<string>",
      "email_sender": {
        "email": "<string>",
        "object": "<string>",
        "reply_to": "<string>",
        "user_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "expired_at": "2023-11-07T05:31:56Z",
        "is_nylas_connection": true,
        "is_nylas_grant_expired": true,
        "is_shared": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "provider": "<string>",
        "reply_to_name": "<string>",
        "signature_html": "<string>"
      },
      "email_sender_id": "<string>",
      "error_message": "<string>",
      "from_email": "<string>",
      "generated_body": "<string>",
      "is_automated": true,
      "is_generated": true,
      "is_originated_in_stuut": true,
      "is_unread": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "parent_email_id": "<string>",
      "participants": [
        "jsmith@example.com"
      ],
      "remote_id": "<string>",
      "remote_links": [
        {
          "email_id": "<string>",
          "email_sender_id": "<string>",
          "object": "<string>",
          "remote_id": "<string>",
          "remote_thread_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z"
        }
      ],
      "reply_to": [
        "<string>"
      ],
      "send_separately": true,
      "sent_at": "2023-11-07T05:31:56Z",
      "sent_by_id": "<string>",
      "snippet": "<string>",
      "status": "draft",
      "subject": "<string>",
      "to": [
        "<string>"
      ]
    },
    "modified_at": "2023-11-07T05:31:56Z",
    "partner": {
      "id": "<string>",
      "account_number": "<string>",
      "ap_portals": [
        {
          "object": "<string>",
          "partner_id": "<string>",
          "id": "<string>",
          "account": {
            "object": "<string>",
            "organization_id": "<string>",
            "provider": "coupa",
            "id": "<string>",
            "available_operations": "<unknown>",
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z"
          },
          "account_id": "<string>",
          "account_key": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "customer_identifier": "<string>",
          "customer_name": "<string>",
          "invoice_submission_guidelines": "<string>",
          "is_enabled": true,
          "is_invoice_submission_enabled": true,
          "is_report_download_enabled": true,
          "modified_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "provider": "coupa",
          "report_email": "<string>",
          "report_frequency": "daily"
        }
      ],
      "assignee": {
        "email": "<string>",
        "family_name": "<string>",
        "given_name": "<string>",
        "object": "<string>",
        "organization_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "dashboard_settings": {
          "thread_emails_sort_order": "asc"
        },
        "default_email_sender_id": "<string>",
        "invited_by_user_id": "<string>",
        "is_access_approved": true,
        "is_org_admin": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "onboarding_required": true,
        "profile_picture": "<string>",
        "selected": true
      },
      "assignee_id": "<string>",
      "billing_address": {
        "object": "<string>",
        "city": "<string>",
        "coordinates": {},
        "country": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "phone": "<string>",
        "postal_code": "<string>",
        "remote_id": "<string>",
        "state": "<string>",
        "type": "<string>"
      },
      "billing_address_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "ADP",
      "custom_fields": "<unknown>",
      "description": "<string>",
      "email": "<string>",
      "family_name": "<string>",
      "finix_identity_id": "<string>",
      "given_name": "<string>",
      "invoice_prefix": "<string>",
      "is_active": true,
      "is_company": true,
      "is_email_disabled": true,
      "is_phone_disabled": true,
      "is_primary_email": true,
      "is_primary_phone": true,
      "last_outreach_at": "2023-11-07T05:31:56Z",
      "last_outreach_channel": "email",
      "last_outreach_to": "<string>",
      "last_synced_at": "2023-11-07T05:31:56Z",
      "legal_name": "<string>",
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "object": "<string>",
      "on_behalf_of": "<string>",
      "on_behalf_of_phone": "<string>",
      "organization_id": "<string>",
      "parent_id": "<string>",
      "phone": "<string>",
      "remote_created_at": "2023-11-07T05:31:56Z",
      "remote_id": "<string>",
      "remote_metadata": null,
      "remote_modified_at": "2023-11-07T05:31:56Z",
      "remote_parent_id": "<string>",
      "remote_payment_portal_url": "<string>",
      "shipping_address": {
        "object": "<string>",
        "city": "<string>",
        "coordinates": {},
        "country": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "phone": "<string>",
        "postal_code": "<string>",
        "remote_id": "<string>",
        "state": "<string>",
        "type": "<string>"
      },
      "status_metadata": "<unknown>",
      "sync_status": "partial",
      "tags": [
        {
          "object": "<string>",
          "partner_id": "<string>",
          "tag_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "is_manual": true,
          "modified_at": "2023-11-07T05:31:56Z",
          "tag": {
            "name": "<string>",
            "object": "<string>",
            "id": "<string>",
            "color": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "rule_condition": {}
          }
        }
      ],
      "tax_number": "<string>",
      "timezone": "Africa/Abidjan"
    },
    "payee_bank_details": {
      "account_number": null,
      "bank_name": null,
      "bank_number": null,
      "branch_number": null,
      "iban": null,
      "type": null
    },
    "payer_bank_details": {
      "account_number": null,
      "bank_name": null,
      "bank_number": null,
      "branch_number": null,
      "iban": null,
      "type": null
    },
    "payer_email": "<string>",
    "payer_name": "<string>",
    "payment_method": "<string>",
    "status": "submitted",
    "transaction_amount": 123,
    "transaction_date": "2023-12-25",
    "transaction_number": "<string>"
  },
  "remittance_id": "<string>",
  "remote_created_at": "2023-11-07T05:31:56Z",
  "remote_id": "<string>",
  "remote_metadata": null,
  "remote_modified_at": "2023-11-07T05:31:56Z",
  "statement_descriptor": "<string>",
  "stripe_session_id": "<string>",
  "sync_status": "partial",
  "transaction_match_approved_at": "2023-11-07T05:31:56Z",
  "transaction_match_approver_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
payment_id
string
required

Response

Successful response

​
amount
integer
required

The gross amount (less any fees) in the currency's smallest unit, e.g. $10 USD would be represented as 1000. amount must be >= 0

​
currency
enum<string>
required

The ISO-4217 currency code of the payment.

Available options:
ADP,
AED,
AFA,
AFN,
ALK,
ALL,
AMD,
ANG,
AOA,
AOK,
AON,
AOR,
ARA,
ARL,
ARM,
ARP,
ARS,
ATS,
AUD,
AWG,
AZM,
AZN,
BAD,
BAM,
BAN,
BBD,
BDT,
BEC,
BEF,
BEL,
BGL,
BGM,
BGN,
BGO,
BHD,
BIF,
BMD,
BND,
BOB,
BOL,
BOP,
BOV,
BRB,
BRC,
BRE,
BRL,
BRN,
BRR,
BRZ,
BSD,
BTN,
BUK,
BWP,
BYB,
BYN,
BYR,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLE,
CLF,
CLP,
CNH,
CNX,
CNY,
COP,
COU,
CRC,
CSD,
CSK,
CUC,
CUP,
CVE,
CYP,
CZK,
DDM,
DEM,
DJF,
DKK,
DOP,
DZD,
ECS,
ECV,
EEK,
EGP,
ERN,
ESA,
ESB,
ESP,
ETB,
EUR,
FIM,
FJD,
FKP,
FRF,
GBP,
GEK,
GEL,
GHC,
GHS,
GIP,
GMD,
GNF,
GNS,
GQE,
GRD,
GTQ,
GWE,
GWP,
GYD,
HKD,
HNL,
HRD,
HRK,
HTG,
HUF,
IDR,
IEP,
ILP,
ILR,
ILS,
INR,
IQD,
IRR,
ISJ,
ISK,
ITL,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRH,
KRO,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LTT,
LUC,
LUF,
LUL,
LVL,
LVR,
LYD,
MAD,
MAF,
MCF,
MDC,
MDL,
MGA,
MGF,
MKD,
MKN,
MLF,
MMK,
MNT,
MOP,
MRO,
MRU,
MTL,
MTP,
MUR,
MVP,
MVR,
MWK,
MXN,
MXP,
MXV,
MYR,
MZE,
MZM,
MZN,
NAD,
NGN,
NIC,
NIO,
NLG,
NOK,
NPR,
NZD,
OMR,
PAB,
PEI,
PEN,
PES,
PGK,
PHP,
PKR,
PLN,
PLZ,
PTE,
PYG,
QAR,
RHD,
ROL,
RON,
RSD,
RUB,
RUR,
RWF,
SAR,
SBD,
SCR,
SDD,
SDG,
SDP,
SEK,
SGD,
SHP,
SIT,
SKK,
SLE,
SLL,
SOS,
SRD,
SRG,
SSP,
STD,
STN,
SUR,
SVC,
SYP,
SZL,
THB,
TJR,
TJS,
TMM,
TMT,
TND,
TOP,
TPE,
TRL,
TRY,
TTD,
TWD,
TZS,
UAH,
UAK,
UGS,
UGX,
USD,
USN,
USS,
UYI,
UYP,
UYU,
UYW,
UZS,
VEB,
VED,
VEF,
VES,
VND,
VNN,
VUV,
WST,
XAF,
XAG,
XAU,
XBA,
XBB,
XBC,
XBD,
XCD,
XCG,
XDR,
XEU,
XFO,
XFU,
XOF,
XPD,
XPF,
XPT,
XRE,
XSU,
XTS,
XUA,
XXX,
YDD,
YER,
YUD,
YUM,
YUN,
YUR,
ZAL,
ZAR,
ZMK,
ZMW,
ZRN,
ZRZ,
ZWD,
ZWL,
ZWR
Maximum string length: 3
​
object
string
required
​
partner_id
string
required

The id of the partner that made this payment.

Maximum string length: 32
​
status
enum<string>
required

The status of the payment.

Available options:
pending_match,
pending_approval,
approved,
finalized
Maximum string length: 16
​
timestamp
string<date-time>
required

If posted, the time the payment posted. Otherwise the time the payment is expected or initiated.

​
id
string
Maximum string length: 32
​
agent_confidence_reason
string | null

The justification for the agent's confidence score.

​
agent_confidence_score
integer | null

The confidence score of the result on a scale of 0-100, where 0 indicates no confidence in the accuracy of the result and 100 indicates full confidence in the accuracy of the result.

​
agent_error_code
string | null

The code for why an error occurred when processing the statement.

​
agent_uncertainties
string[]

A list of uncertainties we have regarding the result.

​
allocations
object[]
​
amount_refunded
integer

The amount refunded in the currency's smallest unit, e.g. $10 USD would be represented as 1000. amount must be >= 0

​
bank_transaction
object
​
bank_transaction_id
string | null

The bank_transaction this payment was reconciled to.

Maximum string length: 32
​
billing_email
string | null

The billing email address of the payment

Maximum string length: 255
​
created_at
string<date-time>
​
currency_rate
integer | null
​
custom_fields
any
​
description
string | null

The memo, remark, or description associated with the payment/transaction.

​
expected_at
string<date-time> | null

When the payment is expected to post.

​
finix_transfer_id
string | null
Maximum string length: 32
​
initiated_at
string<date-time> | null

The time at which the payment was initiated.

​
last_exported_at
string<date-time> | null

The time at which the payment was last exported.

​
last_synced_at
string<date-time> | null
​
linked_integration_id
string | null

The linked_integration this payment was originated from, if any.

Maximum string length: 32
​
modified_at
string<date-time> | null
​
partner
object
​
payment_method
enum<string> | null

The payment method used to make the payment.

Available options:
ach,
alipay,
au_becs,
bacs,
card,
cash,
check,
ideal,
interac,
eft,
eps,
giropay,
klarna,
sepa,
wechat,
wire,
other,
null
Maximum string length: 7
​
receipt_url
string | null
​
reference_number
string | null

A unique identifier for the payment.

​
remittance
object
​
remittance_id
string | null

The id of the remittance this payment originated from.

Maximum string length: 32
​
remote_created_at
string<date-time> | null

When the third party's entry was created.

​
remote_id
string | null

The unique identifier of the payment in the system it originated from, e.g. a stripe charge

​
remote_metadata
unknown
​
remote_modified_at
string<date-time> | null

When the third party's entry was updated.

​
statement_descriptor
string | null

The memo, remark, or description associated with the payment/transaction.

​
stripe_session_id
string | null
Maximum string length: 32
​
sync_status
enum<string>

The sync status for this entity.

Available options:
partial,
syncing,
synced,
failed
Maximum string length: 7
​
transaction_match_approved_at
string<date-time> | null

The time at which the transaction match was approved.

​
transaction_match_approver_id
string | null
Maximum string length: 32